Add apiref folder

equinor · Feb 8, 2024 · 924f86b · 924f86b
1 parent 2e02010
commit 924f86b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -71,7 +71,6 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/*/
 docs/Make*
 docs/make*
 

diff --git a/docs/apiref/modules.rst b/docs/apiref/modules.rst
@@ -0,0 +1,7 @@
+API reference for fmu.sumo.sim2sumo
+===================================
+
+.. toctree::
+   :maxdepth: 4
+
+   sim2sumo
diff --git a/docs/apiref/sim2sumo.rst b/docs/apiref/sim2sumo.rst
@@ -0,0 +1,15 @@
+sim2sumo package
+================
+
+.. automodule:: sim2sumo
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   sim2sumo.sim2sumo
diff --git a/docs/apiref/sim2sumo.sim2sumo.rst b/docs/apiref/sim2sumo.sim2sumo.rst
@@ -0,0 +1,7 @@
+sim2sumo.sim2sumo module
+========================
+
+.. automodule:: sim2sumo.sim2sumo
+   :members:
+   :show-inheritance:
+   :inherited-members: