From 53162e21898d2dce317db46841334c23c3031ad0 Mon Sep 17 00:00:00 2001 From: Paul Menczel Date: Wed, 29 May 2024 16:53:39 +0900 Subject: [PATCH] Changed autosummary module template --- doc/_templates/module.rst | 7 +++++++ doc/apidoc.rst | 10 +++------- doc/conf.py | 1 - 3 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 doc/_templates/module.rst diff --git a/doc/_templates/module.rst b/doc/_templates/module.rst new file mode 100644 index 0000000..0d7436f --- /dev/null +++ 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 index 90a0993..bdaf13c 100644 --- 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 index 7e60313..c840074 100644 --- 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 ---------------------------------------