module docs autogenerated

nismod · Oct 24, 2024 · b3ea638 · b3ea638
1 parent 93580a4
commit b3ea638
Show file tree

Hide file tree

Showing 14 changed files with 23 additions and 108 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,4 +1,4 @@
-name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+name: Publish Python 🐍 distribution 📦 to PyPI
 
 # on: push
 on:

diff --git a/source/api.rst b/source/api.rst
@@ -1,13 +1,13 @@
 API
 ===
 
-
 The API consists in a set of modules helping with plotting, data ingestion and manipulation. See the guides for a full set of examples and applications.
 
-.. autosummary::
-   :toctree: generated
-   :recursive:
-   :caption: Reference
+.. toctree::
+   :maxdepth: 1
+   :caption: Modules:
 
-   scalenav
-
+   api/rast_converter
+   api/data
+   api/scale_nav
+   api/plotting
diff --git a/source/api/data.rst b/source/api/data.rst
@@ -0,0 +1,3 @@
+
+.. automodule:: scalenav.data
+   :members:
diff --git a/source/api/plotting.rst b/source/api/plotting.rst
@@ -0,0 +1,4 @@
+
+
+.. automodule:: scalenav.plotting
+   :members:
diff --git a/source/api/rast_converter.rst b/source/api/rast_converter.rst
@@ -0,0 +1,5 @@
+
+
+
+.. automodule:: scalenav.rast_converter
+   :members:
diff --git a/source/api/scale_nav.rst b/source/api/scale_nav.rst
@@ -0,0 +1,3 @@
+
+.. automodule:: scalenav.scale_nav
+   :members:
diff --git a/source/generated/scalenav.data.rst b/source/generated/scalenav.data.rst
diff --git a/source/generated/scalenav.oop.rst b/source/generated/scalenav.oop.rst
diff --git a/source/generated/scalenav.plotting.rst b/source/generated/scalenav.plotting.rst
diff --git a/source/generated/scalenav.rast_converter.rst b/source/generated/scalenav.rast_converter.rst
diff --git a/source/generated/scalenav.rst b/source/generated/scalenav.rst
diff --git a/source/generated/scalenav.scale_nav.rst b/source/generated/scalenav.scale_nav.rst
diff --git a/source/generated/scalenav.setup.rst b/source/generated/scalenav.setup.rst
diff --git a/source/generated/scalenav.utils.rst b/source/generated/scalenav.utils.rst