further docs refactor to split modules into separate files

pyswmm · Dec 18, 2024 · 2024bea · 2024bea
1 parent 6645f80
commit 2024bea
Show file tree

Hide file tree

Showing 17 changed files with 81 additions and 82 deletions.
diff --git a/docs/reference/graphics.rst b/docs/reference/graphics.rst
diff --git a/docs/reference/graphics/drawing.rst b/docs/reference/graphics/drawing.rst
@@ -0,0 +1,7 @@
+drawing
+------------------------------
+
+.. automodule:: swmmio.graphics.drawing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/graphics/index.rst b/docs/reference/graphics/index.rst
@@ -0,0 +1,15 @@
+graphics
+====================
+
+.. only:: html
+
+   :Release: |release|
+
+.. toctree::
+   :maxdepth: 2
+
+   swmm_graphics
+   drawing
+   utils
+
+.. only:: html
diff --git a/docs/reference/graphics/swmm_graphics.rst b/docs/reference/graphics/swmm_graphics.rst
@@ -0,0 +1,7 @@
+swmm\_graphics
+-------------------------------------
+
+.. automodule:: swmmio.graphics.swmm_graphics
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/graphics/utils.rst b/docs/reference/graphics/utils.rst
@@ -0,0 +1,7 @@
+utils
+----------------------------
+
+.. automodule:: swmmio.graphics.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -15,7 +15,7 @@ Reference
    swmmio_rpt
    elements
    utils/index
-   graphics
-   version_control
+   graphics/index
+   version_control/index
 
 .. only:: html
diff --git a/docs/reference/utils/dataframes.rst b/docs/reference/utils/dataframes.rst
@@ -1,4 +1,4 @@
-utils.dataframes module
+dataframes
 ------------------------------
 
 .. automodule:: swmmio.utils.dataframes

diff --git a/docs/reference/utils/functions.rst b/docs/reference/utils/functions.rst
@@ -1,4 +1,4 @@
-utils.functions module
+functions
 -----------------------------
 
 .. automodule:: swmmio.utils.functions

diff --git a/docs/reference/utils/index.rst b/docs/reference/utils/index.rst
@@ -1,4 +1,4 @@
-utils package
+utils
 ====================
 
 .. only:: html

diff --git a/docs/reference/utils/modify_model.rst b/docs/reference/utils/modify_model.rst
@@ -1,4 +1,4 @@
-utils.modify\_model module
+modify\_model
 ---------------------------------
 
 .. automodule:: swmmio.utils.modify_model

diff --git a/docs/reference/utils/spatial.rst b/docs/reference/utils/spatial.rst
@@ -1,4 +1,4 @@
-utils.spatial module
+spatial
 ---------------------------
 
 .. automodule:: swmmio.utils.spatial

diff --git a/docs/reference/utils/text.rst b/docs/reference/utils/text.rst
@@ -1,4 +1,4 @@
-utils.text module
+text
 ------------------------
 
 .. automodule:: swmmio.utils.text

diff --git a/docs/reference/version_control.rst b/docs/reference/version_control.rst
diff --git a/docs/reference/version_control/index.rst b/docs/reference/version_control/index.rst
@@ -0,0 +1,15 @@
+version control
+====================
+
+.. only:: html
+
+   :Release: |release|
+
+.. toctree::
+   :maxdepth: 2
+
+   inp
+   version_control
+   utils
+
+.. only:: html
diff --git a/docs/reference/version_control/inp.rst b/docs/reference/version_control/inp.rst
@@ -0,0 +1,8 @@
+inp
+----------------------------------
+
+.. automodule:: swmmio.version_control.inp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/reference/version_control/utils.rst b/docs/reference/version_control/utils.rst
@@ -0,0 +1,7 @@
+utils
+------------------------------------
+
+.. automodule:: swmmio.version_control.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/version_control/version_control.rst b/docs/reference/version_control/version_control.rst
@@ -0,0 +1,7 @@
+version\_control
+-----------------------------------------------
+
+.. automodule:: swmmio.version_control.version_control
+   :members:
+   :undoc-members:
+   :show-inheritance: