update docs

mdtanker · Nov 20, 2023 · 9dd1e2a · 9dd1e2a
1 parent 5d43c41
commit 9dd1e2a
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 2 deletions.
diff --git a/docs/api/invert4geom.inversion.rst b/docs/api/invert4geom.inversion.rst
@@ -3,4 +3,4 @@ invert4geom.inversion
 .. automodule:: invert4geom.inversion
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/docs/api/invert4geom.plotting.rst b/docs/api/invert4geom.plotting.rst
@@ -0,0 +1,6 @@
+invert4geom.plotting
+--------------------
+.. automodule:: invert4geom.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/invert4geom.rst b/docs/api/invert4geom.rst
@@ -6,4 +6,6 @@ API Reference
    :maxdepth: 4
 
    invert4geom.inversion
+   invert4geom.plotting
+   invert4geom.synthetic
    invert4geom.utils
diff --git a/docs/api/invert4geom.synthetic.rst b/docs/api/invert4geom.synthetic.rst
@@ -0,0 +1,6 @@
+invert4geom.synthetic
+---------------------
+.. automodule:: invert4geom.synthetic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/invert4geom.utils.rst b/docs/api/invert4geom.utils.rst
@@ -3,4 +3,4 @@ invert4geom.utils
 .. automodule:: invert4geom.utils
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/docs/index.md b/docs/index.md
@@ -9,11 +9,19 @@ install
 gallery/index
 ```
 
+```{toctree}
+:maxdepth: 1
+:hidden:
+:caption: User guide
+user_guide/simple_inversion
+```
+
 ```{toctree}
 :maxdepth: 1
 :hidden:
 :caption: Reference documentation
 api/invert4geom
+citing.md
 ```
 
 ```{toctree}