Merge pull request #79 from sebastienbarbier/develop

Fix documentation
sebastienbarbier · Apr 25, 2023 · 6536d03 · 6536d03
2 parents bad67fd + 21d1fdb
commit 6536d03
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 11 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -7,7 +7,7 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
     python: "3.9"
     # You can also specify other tool versions:
@@ -26,4 +26,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: requirements-dev.txt
diff --git a/docs/changelogs.md b/docs/changelogs.md
@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```
diff --git a/docs/changelogs.rst b/docs/changelogs.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -74,7 +74,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -147,7 +147,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -7,16 +7,20 @@ certifi==2022.12.7
 charset-normalizer==3.1.0
 colorama==0.4.6
 dill==0.3.6
-docutils==0.18
+docutils==0.17
 idna==3.4
 imagesize==1.4.1
 importlib-metadata==6.4.1
 isort==5.12.0
 Jinja2==3.1.2
 lazy-object-proxy==1.9.0
 livereload==2.6.3
+markdown-it-py==2.2.0
 MarkupSafe==2.1.2
 mccabe==0.7.0
+mdit-py-plugins==0.3.5
+mdurl==0.1.2
+myst-parser==1.0.0
 packaging==23.1
 pathtools==0.1.2
 pip-review==1.3.0
@@ -26,15 +30,17 @@ pylint==2.17.2
 pylint-django==2.5.3
 pylint-plugin-utils==0.7
 PyMySQL==1.0.3
+PyYAML==6.0
 requests==2.28.2
 six==1.16.0
 snowballstemmer==2.2.0
-Sphinx==6.1.3
+Sphinx==5.3.0
 sphinx-autobuild==2021.3.14
-sphinx-rtd-theme==1.2.0
-sphinxcontrib-applehelp==1.0.4
+sphinx-reload==0.2.0
+sphinx-rtd-theme==1.1.1
+sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-htmlhelp==2.0.0
 sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
@@ -46,4 +52,4 @@ typing_extensions==4.5.0
 urllib3==1.26.15
 watchdog==3.0.0
 wrapt==1.15.0
-zipp==3.15.0
+zipp==3.15.0