Changed autosummary module template

qutip · May 29, 2024 · 53162e2 · 53162e2
1 parent 7c72fd6
commit 53162e2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/doc/_templates/module.rst b/doc/_templates/module.rst
@@ -0,0 +1,7 @@
+{{ ["Module ", fullname] | join | escape | underline}}
+
+.. automodule:: {{ fullname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/doc/apidoc.rst b/doc/apidoc.rst
@@ -2,17 +2,13 @@ qutip\_qoc package
 ===================
 
 
-.. toctree::
-   :maxdepth: 1
-
-
 High-level interfaces
 ---------------------
 High-level interfaces to the optimal control features.
 
 .. autosummary::
    :toctree: apidoc/
-   :template: apidoc/module.rst
+   :template: module.rst
 
    qutip_qoc.pulse_optim
 
@@ -23,7 +19,7 @@ Optimal control utility functions.
 
 .. autosummary::
    :toctree: apidoc/
-   :template: apidoc/module.rst
+   :template: module.rst
 
    qutip_qoc.result
    qutip_qoc.objective
@@ -34,7 +30,7 @@ Internal interfaces to the optimal control features.
 
 .. autosummary::
    :toctree: apidoc/
-   :template: apidoc/module.rst
+   :template: module.rst
 
    qutip_qoc._optimizer
    qutip_qoc._goat

diff --git a/doc/conf.py b/doc/conf.py
@@ -78,7 +78,6 @@ def qutip_qoc_version():
 # functions/classes. However, pay attention that some api docs files are
 # adjusted manually for better illustration and should not be overwritten.
 autosummary_generate = True
-autosummary_imported_members = True
 
 # -- Options for biblatex ---------------------------------------