Bind Functions Again, Write Presentation (#46)

* [gha] move  into place

* [docs] add API documentation page

* [docs] summarize epiworldpy

* [docs] turn of recursive generation

* [doc] reintroduce epiworld summary

* [bind] bind those functions again

* [interactives] create, sequester

* [cleanup] misc cleanup tasks

* [presentation] polish

.github/workflows/sphinx.yaml

@@ -48,11 +48,16 @@ jobs:
 
       # Building
       - name: Render Quarto File
-        run: quarto render README.qmd --to rst && mv README.rst docs/index.rst
+        run: |
+          quarto render README.qmd --to rst
+          mv README.rst docs/index.rst
 
       - name: Build HTML using Sphinx
         run: sphinx-build -M html docs docs/build/
 
+      - name: Move Assets into Place
+        run: mv README_files docs/build/html
+
       # Upload
       - name: Upload artifacts
         uses: actions/upload-pages-artifact@v3

.gitignore

@@ -8,3 +8,7 @@ __pycache__/
 compile_commands.json
 *.html
 *.ipynb
+.nocheck/
+
+*_files
+!README_files

README.qmd

@@ -18,6 +18,10 @@ The `epiworld` module is already
 - clone this repository
 - `pip install ./epiworldpy`
 
+# API
+
+You can find API documentation on the [API page](/api.html).
+
 # Examples 
 
 ## Basic

docs/api.rst

@@ -0,0 +1,10 @@
+API
+===
+
+You can find the complete API documentation for `epiworldpy` below.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   epiworldpy

docs/conf.py

@@ -28,6 +28,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
 ]