From c801e79d4b78fce44a40f4bebc3fc411088fc615 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sun, 18 Oct 2020 21:33:30 +0200 Subject: [PATCH 1/6] Fix readthedocs build that failed by making it use python3 instead of default python2.7 --- .readthedocs.yml | 20 ++++++++++++++++++++ requirements.txt | 6 +++--- 2 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..f4ada8bb --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,20 @@ +# .readthedocs.yml +# 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 +formats: + - pdf + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs/requirements.txt diff --git a/requirements.txt b/requirements.txt index 0ce39f74..abd12629 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -pymongo>=3.4 -Sphinx==1.5.5 -sphinx-rtd-theme==0.2.4 +pymongo>=3.11 +Sphinx==3.2.1 +sphinx-rtd-theme==0.5.0 From eb1694514713c7e45ded4b0cbf4fa20c0a855fac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sun, 18 Oct 2020 22:06:15 +0200 Subject: [PATCH 2/6] fix requirements.txt location for readthedocs --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index f4ada8bb..60b4ae4d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -17,4 +17,4 @@ formats: python: version: 3.7 install: - - requirements: docs/requirements.txt + - requirements: requirements.txt From 6b657886a5341a4cd3866701631b2843449706d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sun, 18 Oct 2020 22:21:45 +0200 Subject: [PATCH 3/6] remove explicit install from .readthedocs.yml to rely on default instead --- .readthedocs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 60b4ae4d..324d7e56 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -16,5 +16,3 @@ formats: # Optionally set the version of Python and requirements required to build your docs python: version: 3.7 - install: - - requirements: requirements.txt From e362d089e137501b40b9dad7001a7bc202ddde8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sun, 18 Oct 2020 22:44:06 +0200 Subject: [PATCH 4/6] install mongoengine for readthedocs build to work --- .readthedocs.yml | 8 ++++---- requirements.txt => docs/requirements.txt | 0 2 files changed, 4 insertions(+), 4 deletions(-) rename requirements.txt => docs/requirements.txt (100%) diff --git a/.readthedocs.yml b/.readthedocs.yml index 324d7e56..f1d0c068 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,10 +9,10 @@ version: 2 sphinx: configuration: docs/conf.py -# Optionally build your docs in additional formats such as PDF -formats: - - pdf - # Optionally set the version of Python and requirements required to build your docs python: version: 3.7 + install: + - requirements: docs/requirements.txt + - method: setuptools + path: mongoengine diff --git a/requirements.txt b/docs/requirements.txt similarity index 100% rename from requirements.txt rename to docs/requirements.txt From 4286708e2e61608cb815d9aa829365cc48636a62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sun, 18 Oct 2020 22:47:00 +0200 Subject: [PATCH 5/6] fix mongoengine setup.py path in .readthedocs.yml --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index f1d0c068..add282fa 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -15,4 +15,4 @@ python: install: - requirements: docs/requirements.txt - method: setuptools - path: mongoengine + path: . From d8a52d68c51396313fe4e62aff13245d939aa4f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Mon, 19 Oct 2020 23:34:24 +0200 Subject: [PATCH 6/6] improve doc in .readthedocs.yml --- .readthedocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index add282fa..08a36676 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -14,5 +14,7 @@ python: version: 3.7 install: - requirements: docs/requirements.txt + # docs/conf.py is importing mongoengine + # so mongoengine needs to be installed as well - method: setuptools path: .