From b58d7f341001fc9ed2a4be306040c52828a7d593 Mon Sep 17 00:00:00 2001 From: Satrajit Ghosh Date: Sat, 18 Apr 2020 13:36:09 -0400 Subject: [PATCH 1/2] enh: add readthedocs markup for building docs --- .readthedocs.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000000..6b05eeddbe --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,18 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs/requirements.txt From d3a965cd0f37cf05f8c560fb1c4d06805f99b3c3 Mon Sep 17 00:00:00 2001 From: Satrajit Ghosh Date: Sat, 18 Apr 2020 13:40:09 -0400 Subject: [PATCH 2/2] fix: path --- .readthedocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 6b05eeddbe..e139918f30 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,7 +6,7 @@ version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: doc/conf.py # Optionally build your docs in additional formats such as PDF and ePub formats: all @@ -15,4 +15,4 @@ formats: all python: version: 3.7 install: - - requirements: docs/requirements.txt + - requirements: doc/requirements.txt