[docs] add API documentation page

UofUEpiBio · Sep 18, 2024 · 66034a2 · 66034a2
1 parent 4ea141c
commit 66034a2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.qmd b/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

diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,5 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,6 +28,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
 ]