Merge pull request #55 from vnmabus/feature/contributor_docs

Add the contributors page to the documentation.
vnmabus · Sep 14, 2023 · 58f0dfa · 58f0dfa
2 parents 9f2b243 + 2fc29d3
commit 58f0dfa
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -55,6 +55,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser",
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.todo',

diff --git a/docs/contributors.md b/docs/contributors.md
@@ -0,0 +1,2 @@
+```{include} ../CONTRIBUTORS.md
+```
diff --git a/docs/index.rst b/docs/index.rst
@@ -33,6 +33,7 @@ References
    energycomparison
    Release Notes <https://github.com/vnmabus/dcor/releases>
    development
+   contributors
 
 dcor is developed `on Github <http://github.com/vnmabus/dcor>`_. Please
 report `issues <https://github.com/vnmabus/dcor/issues>`_ there as well.

diff --git a/readthedocs-requirements.txt b/readthedocs-requirements.txt
@@ -5,6 +5,7 @@ sphinxcontrib-bibtex
 sphinx-gallery
 jupyter-sphinx
 matplotlib
+myst-parser
 pygments>=2.4.1
 # Fix docutils version due to https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/309
 docutils==0.17.1