cleaning and updating documentation (#34)

* remove the old python documentation as it is now integrated into the sphinx documentation * raise errors if the notebooks does not run correctly * use sphinx-proofs in the theory section * test for pydocstyle in CI * various docstrings improvements * update tutorials * add systole and bokeh to docs requirements
ComputationalPsychiatry · Feb 21, 2023 · e710f17 · e710f17
1 parent 3110477
commit e710f17
Show file tree

Hide file tree

Showing 119 changed files with 1,085 additions and 33,020 deletions.
diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -29,9 +29,10 @@ jobs:
     - name: Install dependencies
       run: |
         pip install -r requirements.txt
-        pip install isort==5.10.1 flake8 black==22.12.0
-    - name: Run tests and coverage
+        pip install isort==5.10.1 flake8 black==22.12.0 pydocstyle==6.3.0
+    - name: Run linting
       run: |
         flake8 ./pyhgf/
         black ./pyhgf/
         isort ./pyhgf/
+        pydocstyle pyhgf/. --ignore=D213,D100,D203,D104
diff --git a/docs/old/chapters/appendix.tex b/docs/old/chapters/appendix.tex
diff --git a/docs/old/chapters/continuoustime.tex b/docs/old/chapters/continuoustime.tex
diff --git a/docs/old/chapters/genmodel.tex b/docs/old/chapters/genmodel.tex
diff --git a/docs/old/chapters/implementation.tex b/docs/old/chapters/implementation.tex
diff --git a/docs/old/chapters/node.tex b/docs/old/chapters/node.tex