From 97b43e1a16642540fb3927fd12b5f5372bd2b308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20L=C3=BCbke?= Date: Wed, 1 Nov 2023 08:51:45 +0100 Subject: [PATCH] doc: adding contributors --- .gitlab-ci.yml | 2 +- CONTRIBUTORS.md | 11 +++++++++++ docs_sphinx/conf.py | 3 ++- docs_sphinx/contributors.rst | 1 + docs_sphinx/index.rst | 1 + 5 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTORS.md create mode 100644 docs_sphinx/contributors.rst diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d69c110..4f3100c 100644 --- a/.gitlab-ci.yml +++ b/.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 diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..5e7e90f --- /dev/null +++ b/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. diff --git a/docs_sphinx/conf.py b/docs_sphinx/conf.py index f193aa9..9087a8a 100644 --- a/docs_sphinx/conf.py +++ b/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" diff --git a/docs_sphinx/contributors.rst b/docs_sphinx/contributors.rst new file mode 100644 index 0000000..94c1dce --- /dev/null +++ b/docs_sphinx/contributors.rst @@ -0,0 +1 @@ +.. mdinclude:: ../CONTRIBUTORS.md diff --git a/docs_sphinx/index.rst b/docs_sphinx/index.rst index 6c5d9ce..7f64d4f 100644 --- a/docs_sphinx/index.rst +++ b/docs_sphinx/index.rst @@ -49,3 +49,4 @@ Table of Contents developer examples visualization + contributors