Merge pull request #342 from Terralego/fix_docs_and_deps

New RtD config, update & improve docs and dev dependencies

dev-requirements.in

@@ -1,4 +1,5 @@
 -c requirements.txt
+-r docs/requirements.txt
 
 django-debug-toolbar
 freezegun
@@ -7,5 +8,4 @@ isort
 black
 factory-boy
 coverage
-pip-tools
-sphinx-rtd-theme
+pip-tools

dev-requirements.txt

@@ -5,24 +5,30 @@
 #    pip-compile dev-requirements.in
 #
 alabaster==0.7.13
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 asgiref==3.6.0
     # via
     #   -c requirements.txt
     #   django
 babel==2.12.1
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 black==23.7.0
     # via -r dev-requirements.in
 build==0.10.0
     # via pip-tools
-certifi==2022.12.7
+certifi==2023.7.22
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   requests
 charset-normalizer==3.1.0
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   requests
 click==8.1.3
     # via
@@ -39,11 +45,12 @@ django-debug-toolbar==4.2.0
     # via -r dev-requirements.in
 docutils==0.18.1
     # via
+    #   -r docs/requirements.txt
     #   sphinx
     #   sphinx-rtd-theme
 factory-boy==3.3.0
     # via -r dev-requirements.in
-faker==17.4.0
+faker==19.3.1
     # via factory-boy
 flake8==6.1.0
     # via -r dev-requirements.in
@@ -52,37 +59,47 @@ freezegun==1.2.2
 idna==3.4
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   requests
 imagesize==1.4.1
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 isort==5.12.0
     # via -r dev-requirements.in
 jinja2==3.1.2
-    # via sphinx
-markupsafe==2.1.2
-    # via jinja2
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
+markupsafe==2.1.3
+    # via
+    #   -r docs/requirements.txt
+    #   jinja2
 mccabe==0.7.0
     # via flake8
 mypy-extensions==1.0.0
     # via black
 packaging==23.1
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   black
     #   build
     #   sphinx
-pathspec==0.11.0
+pathspec==0.11.2
     # via black
 pip-tools==7.3.0
     # via -r dev-requirements.in
-platformdirs==3.0.0
+platformdirs==3.10.0
     # via black
 pycodestyle==2.11.0
     # via flake8
 pyflakes==3.1.0
     # via flake8
-pygments==2.15.0
-    # via sphinx
+pygments==2.16.1
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 pyproject-hooks==1.0.0
     # via build
 python-dateutil==2.8.2
@@ -93,34 +110,56 @@ python-dateutil==2.8.2
 requests==2.31.0
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   sphinx
 six==1.16.0
     # via
     #   -c requirements.txt
     #   python-dateutil
 snowballstemmer==2.2.0
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 sphinx==7.2.5
     # via
+    #   -r docs/requirements.txt
     #   sphinx-rtd-theme
+    #   sphinxcontrib-applehelp
+    #   sphinxcontrib-devhelp
+    #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-jquery
+    #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
 sphinx-rtd-theme==1.3.0
-    # via -r dev-requirements.in
-sphinxcontrib-applehelp==1.0.4
-    # via sphinx
-sphinxcontrib-devhelp==1.0.2
-    # via sphinx
-sphinxcontrib-htmlhelp==2.0.1
-    # via sphinx
+    # via -r docs/requirements.txt
+sphinxcontrib-applehelp==1.0.7
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
+sphinxcontrib-devhelp==1.0.5
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
+sphinxcontrib-htmlhelp==2.0.4
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 sphinxcontrib-jquery==4.1
-    # via sphinx-rtd-theme
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx-rtd-theme
 sphinxcontrib-jsmath==1.0.1
-    # via sphinx
-sphinxcontrib-qthelp==1.0.3
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
+sphinxcontrib-qthelp==1.0.6
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 sphinxcontrib-serializinghtml==1.1.9
-    # via sphinx
+    # via
+    #   -r docs/requirements.txt
+    #   sphinx
 sqlparse==0.4.4
     # via
     #   -c requirements.txt
@@ -135,8 +174,9 @@ tomli==2.0.1
 urllib3==1.26.15
     # via
     #   -c requirements.txt
+    #   -r docs/requirements.txt
     #   requests
-wheel==0.38.4
+wheel==0.41.2
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file:

docs/.readthedocs.yml

@@ -0,0 +1,12 @@
+version: 2
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+   - pdf
+   - epub

docs/requirements.in

@@ -0,0 +1,3 @@
+-c ../requirements.txt
+
+sphinx-rtd-theme

docs/requirements.txt

@@ -1,2 +1,73 @@
-sphinx
-sphinx-rtd-theme
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.12.1
+    # via sphinx
+certifi==2023.7.22
+    # via
+    #   -c ../requirements.txt
+    #   requests
+charset-normalizer==3.1.0
+    # via
+    #   -c ../requirements.txt
+    #   requests
+docutils==0.18.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.4
+    # via
+    #   -c ../requirements.txt
+    #   requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via sphinx
+markupsafe==2.1.3
+    # via jinja2
+packaging==23.1
+    # via
+    #   -c ../requirements.txt
+    #   sphinx
+pygments==2.16.1
+    # via sphinx
+requests==2.31.0
+    # via
+    #   -c ../requirements.txt
+    #   sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==7.2.5
+    # via
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-applehelp
+    #   sphinxcontrib-devhelp
+    #   sphinxcontrib-htmlhelp
+    #   sphinxcontrib-jquery
+    #   sphinxcontrib-qthelp
+    #   sphinxcontrib-serializinghtml
+sphinx-rtd-theme==1.3.0
+    # via -r requirements.in
+sphinxcontrib-applehelp==1.0.7
+    # via sphinx
+sphinxcontrib-devhelp==1.0.5
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.4
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.6
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.9
+    # via sphinx
+urllib3==1.26.15
+    # via
+    #   -c ../requirements.txt
+    #   requests

requirements.txt

@@ -22,7 +22,7 @@ celery==5.3.3
     #   django-celery-beat
     #   django-celery-results
     #   django-geostore
-certifi==2022.12.7
+certifi==2023.7.22
     # via
     #   elastic-transport
     #   fiona