Use automodapi to document all classes

The automodapi creates one page for all classes, and displays a complete list of class names in the navigation section.
OPM · Jan 24, 2021 · adcccdc · adcccdc
1 parent 3792a1b
commit adcccdc
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 8 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,4 +1,5 @@
 __pycache__
 build
 _build
-.vscode
+.vscode
+api
diff --git a/docs/source/GeneratedClasses.rst b/docs/source/GeneratedClasses.rst
@@ -15,9 +15,6 @@ You can look for objects of a specific type by using the **descendants** method
    # Get a list of all Eclipsev view in the project
    views = resinsight.project.descendants(rips.EclipseView)
 
-.. automodule:: rips
-    :members:
-    :noindex:
-    :inherited-members:
-    :show-inheritance:
-
+.. automodapi:: rips
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,7 +34,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon', 'm2r'
+    'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon', 'm2r', 'sphinx_automodapi.automodapi'
 ]
 
 master_doc = 'index'