Add CV to the Documentation

fuzhanrahmanian · Dec 11, 2023 · ed41f41 · ed41f41
1 parent 82f247c
commit ed41f41
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -59,4 +59,7 @@
 html_static_path = ['_static']
 
 # Napoleon settings
-napoleon_google_docstring = True
+napoleon_google_docstring = True
+
+# Automatically generate autosummary pages
+autosummary_generate = True
diff --git a/docs/source/generated_voltammetry/modules.rst b/docs/source/generated_voltammetry/modules.rst
@@ -1,2 +1,7 @@
 Voltammetry
-===========
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   voltammetry
diff --git a/docs/source/generated_voltammetry/voltammetry.rst b/docs/source/generated_voltammetry/voltammetry.rst
@@ -0,0 +1,46 @@
+Voltammetry package
+===================
+
+voltammetry.voltammetry
+--------------------------
+
+.. automodule:: voltammetry.voltammetry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+voltammetry.voltammetry\_CA
+-------------------------------
+
+.. automodule:: voltammetry.voltammetry_CA
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+voltammetry.voltammetry\_CP
+-------------------------------
+
+.. automodule:: voltammetry.voltammetry_CP
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
+
+
+voltammetry.voltammetry\_CV
+-------------------------------
+
+.. automodule:: voltammetry.voltammetry_CP
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+voltammetry.voltammetry\_plotting
+------------------------------------
+
+.. automodule:: voltammetry.voltammetry_plotting
+   :members:
+   :undoc-members:
+   :show-inheritance: