doc update again

GeoStat-Framework · Jan 22, 2019 · 70907a8 · 70907a8
1 parent 55a8185
commit 70907a8
Show file tree

Hide file tree

Showing 64 changed files with 919 additions and 623 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -67,6 +67,9 @@ def setup(app):
 autodoc_member_order = "groupwise"
 # autodoc_member_order = 'bysource'
 
+# don't add full path to module
+add_module_names = False
+
 # Notes in boxes
 napoleon_use_admonition_for_notes = True
 # Attributes like parameters

diff --git a/docs/source/fileclasses.asc.rst b/docs/source/fileclasses.asc.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.asc
+======================
+
+.. automodule:: ogs5py.fileclasses.asc
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.bc.rst b/docs/source/fileclasses.bc.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.bc
+=====================
+
+.. automodule:: ogs5py.fileclasses.bc
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.cct.rst b/docs/source/fileclasses.cct.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.cct
+======================
+
+.. automodule:: ogs5py.fileclasses.cct
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.ddc.rst b/docs/source/fileclasses.ddc.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.ddc
+======================
+
+.. automodule:: ogs5py.fileclasses.ddc
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.fct.rst b/docs/source/fileclasses.fct.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.fct
+======================
+
+.. automodule:: ogs5py.fileclasses.fct
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.gem.rst b/docs/source/fileclasses.gem.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.gem
+======================
+
+.. automodule:: ogs5py.fileclasses.gem
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.gli.generator.rst b/docs/source/fileclasses.gli.generator.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.gli.generator
+================================
+
+.. automodule:: ogs5py.fileclasses.gli.generator
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.gli.rst b/docs/source/fileclasses.gli.rst
@@ -0,0 +1,17 @@
+ogs5py.fileclasses.gli
+======================
+
+.. automodule:: ogs5py.fileclasses.gli
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
+
+.. toctree::
+   :hidden:
+
+   fileclasses.gli.generator.rst
diff --git a/docs/source/fileclasses.ic.rst b/docs/source/fileclasses.ic.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.ic
+=====================
+
+.. automodule:: ogs5py.fileclasses.ic
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.krc.rst b/docs/source/fileclasses.krc.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.krc
+======================
+
+.. automodule:: ogs5py.fileclasses.krc
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.mcp.rst b/docs/source/fileclasses.mcp.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.mcp
+======================
+
+.. automodule:: ogs5py.fileclasses.mcp
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.mfp.rst b/docs/source/fileclasses.mfp.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.mfp
+======================
+
+.. automodule:: ogs5py.fileclasses.mfp
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.mmp.rst b/docs/source/fileclasses.mmp.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.mmp
+======================
+
+.. automodule:: ogs5py.fileclasses.mmp
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.mpd.rst b/docs/source/fileclasses.mpd.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.mpd
+======================
+
+.. automodule:: ogs5py.fileclasses.mpd
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.msh.generator.rst b/docs/source/fileclasses.msh.generator.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.msh.generator
+================================
+
+.. automodule:: ogs5py.fileclasses.msh.generator
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.msh.rst b/docs/source/fileclasses.msh.rst
@@ -0,0 +1,17 @@
+ogs5py.fileclasses.msh
+======================
+
+.. automodule:: ogs5py.fileclasses.msh
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
+
+.. toctree::
+   :hidden:
+
+   fileclasses.msh.generator.rst
diff --git a/docs/source/fileclasses.msp.rst b/docs/source/fileclasses.msp.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.msp
+======================
+
+.. automodule:: ogs5py.fileclasses.msp
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.num.rst b/docs/source/fileclasses.num.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.num
+======================
+
+.. automodule:: ogs5py.fileclasses.num
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.out.rst b/docs/source/fileclasses.out.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.out
+======================
+
+.. automodule:: ogs5py.fileclasses.out
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.pcs.rst b/docs/source/fileclasses.pcs.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.pcs
+======================
+
+.. automodule:: ogs5py.fileclasses.pcs
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.pct.rst b/docs/source/fileclasses.pct.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.pct
+======================
+
+.. automodule:: ogs5py.fileclasses.pct
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.pqc.rst b/docs/source/fileclasses.pqc.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.pqc
+======================
+
+.. automodule:: ogs5py.fileclasses.pqc
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.rei.rst b/docs/source/fileclasses.rei.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.rei
+======================
+
+.. automodule:: ogs5py.fileclasses.rei
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.rfd.rst b/docs/source/fileclasses.rfd.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.rfd
+======================
+
+.. automodule:: ogs5py.fileclasses.rfd
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.rst b/docs/source/fileclasses.rst
@@ -10,4 +10,28 @@ ogs5py.fileclasses
 .. toctree::
    :hidden:
 
-   fileclasses.base.rst
+   fileclasses.base.rst
+   fileclasses.asc.rst
+   fileclasses.bc.rst
+   fileclasses.cct.rst
+   fileclasses.ddc.rst
+   fileclasses.fct.rst
+   fileclasses.gem.rst
+   fileclasses.gli.rst
+   fileclasses.ic.rst
+   fileclasses.krc.rst
+   fileclasses.mcp.rst
+   fileclasses.mfp.rst
+   fileclasses.mmp.rst
+   fileclasses.mpd.rst
+   fileclasses.msh.rst
+   fileclasses.msp.rst
+   fileclasses.num.rst
+   fileclasses.out.rst
+   fileclasses.pcs.rst
+   fileclasses.pct.rst
+   fileclasses.pqc.rst
+   fileclasses.rei.rst
+   fileclasses.rfd.rst
+   fileclasses.st.rst
+   fileclasses.tim.rst
diff --git a/docs/source/fileclasses.st.rst b/docs/source/fileclasses.st.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.st
+=====================
+
+.. automodule:: ogs5py.fileclasses.st
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.tim.rst b/docs/source/fileclasses.tim.rst
@@ -0,0 +1,12 @@
+ogs5py.fileclasses.tim
+======================
+
+.. automodule:: ogs5py.fileclasses.tim
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage