Use pdoc instead of Sphinx

delftdata · Dec 5, 2024 · ac902aa · ac902aa
1 parent 457d2b3
commit ac902aa
Show file tree

Hide file tree

Showing 52 changed files with 40 additions and 5,826 deletions.
diff --git a/README.md b/README.md
@@ -11,13 +11,10 @@ pytest
 ### Documentation
 
 Documentation is done with [Google style docstrings](https://google.github.io/styleguide/pyguide.html) in the source code. 
-It can be generated using Sphinx:
+It can be generated using [pdoc](https://pdoc.dev/docs/pdoc.html):
 
 ```
-cd docs/
-sphinx-apidoc -o source/ ../src
-make html
+pdoc src/cascade
 ```
 
-and then opened at `docs/build/html/index.html`.
 
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/build/doctrees/cascade.dataflow.doctree b/docs/build/doctrees/cascade.dataflow.doctree
diff --git a/docs/build/doctrees/cascade.doctree b/docs/build/doctrees/cascade.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
diff --git a/docs/build/html/.buildinfo.bak b/docs/build/html/.buildinfo.bak
diff --git a/docs/build/html/_sources/cascade.dataflow.rst.txt b/docs/build/html/_sources/cascade.dataflow.rst.txt
diff --git a/docs/build/html/_sources/cascade.rst.txt b/docs/build/html/_sources/cascade.rst.txt
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt