doc: adding contributors

.gitlab-ci.yml

@@ -28,7 +28,7 @@ pages:
   image: python:slim
   before_script:
     - apt-get update && apt-get install --no-install-recommends -y graphviz imagemagick doxygen make
-    - pip install --upgrade pip && pip install Sphinx Pillow breathe sphinx-rtd-theme
+    - pip install --upgrade pip && pip install Sphinx Pillow breathe sphinx-rtd-theme m2r2
     - mkdir public
   script:
     - pushd docs_sphinx

CONTRIBUTORS.md

@@ -0,0 +1,11 @@
+# Contributors
+
+Thank you to all the dedicated individuals who poured their efforts into tug,
+allowing this project to flourish.
+
+## Names
+
+- Hannes Signer
+- Philipp Ungrund
+
+Both for their diligent work in implementing the heterogeneous diffusion model and their exceptional documentation published within this repository.

docs_sphinx/conf.py

@@ -41,7 +41,8 @@ extensions = [
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.inheritance_diagram',
-    'breathe'
+    'breathe',
+    'm2r2'
 ]
 
 html_baseurl = "/index.html"

docs_sphinx/contributors.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../CONTRIBUTORS.md

docs_sphinx/index.rst

@@ -49,3 +49,4 @@ Table of Contents
     developer
     examples
     visualization
+    contributors