From a9f7d674df5ea2c7296f2d4e03dd5719fe0cda59 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Sun, 26 May 2024 09:28:55 +0200 Subject: [PATCH] remove toctree and template --- doc/apidoc.rst | 8 ------- doc/apidoc/qutip_qoc._crab.rst | 24 +++++-------------- doc/apidoc/qutip_qoc._goat.rst | 31 +++++------------------- doc/apidoc/qutip_qoc._grape.rst | 24 +++++-------------- doc/apidoc/qutip_qoc._jopt.rst | 34 +++++--------------------- doc/apidoc/qutip_qoc._optimizer.rst | 31 +++++------------------- doc/apidoc/qutip_qoc._time.rst | 24 +++++-------------- doc/apidoc/qutip_qoc.objective.rst | 30 +++++------------------ doc/apidoc/qutip_qoc.pulse_optim.rst | 30 +++++------------------ doc/apidoc/qutip_qoc.result.rst | 36 +++++----------------------- 10 files changed, 54 insertions(+), 218 deletions(-) diff --git a/doc/apidoc.rst b/doc/apidoc.rst index 02f08a6..c9c80a5 100644 --- a/doc/apidoc.rst +++ b/doc/apidoc.rst @@ -1,18 +1,14 @@ qutip\_qoc package =================== - .. toctree:: :maxdepth: 1 - High-level interfaces --------------------- High-level interfaces to the optimal control features. .. autosummary:: - :toctree: apidoc/ - :template: autosummary/module.rst qutip_qoc.pulse_optim @@ -22,8 +18,6 @@ Utilities Optimal control utility functions. .. autosummary:: - :toctree: apidoc/ - :template: autosummary/module.rst qutip_qoc.result qutip_qoc.objective @@ -33,8 +27,6 @@ Low-level interfaces Internal interfaces to the optimal control features. .. autosummary:: - :toctree: apidoc/ - :template: autosummary/module.rst qutip_qoc._optimizer qutip_qoc._goat diff --git a/doc/apidoc/qutip_qoc._crab.rst b/doc/apidoc/qutip_qoc._crab.rst index 0dfe827..5f0297e 100644 --- a/doc/apidoc/qutip_qoc._crab.rst +++ b/doc/apidoc/qutip_qoc._crab.rst @@ -1,20 +1,8 @@ -qutip\_qoc.\_crab -================= +qutip\_qoc.\_crab module +======================== .. automodule:: qutip_qoc._crab - - - - - - - - - - - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._goat.rst b/doc/apidoc/qutip_qoc._goat.rst index 93e225d..d79a83f 100644 --- a/doc/apidoc/qutip_qoc._goat.rst +++ b/doc/apidoc/qutip_qoc._goat.rst @@ -1,27 +1,8 @@ -qutip\_qoc.\_goat -================= +qutip\_qoc.\_goat module +======================== .. automodule:: qutip_qoc._goat - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Qobj - QobjEvo - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._grape.rst b/doc/apidoc/qutip_qoc._grape.rst index 8097575..2ab0c2b 100644 --- a/doc/apidoc/qutip_qoc._grape.rst +++ b/doc/apidoc/qutip_qoc._grape.rst @@ -1,20 +1,8 @@ -qutip\_qoc.\_grape -================== +qutip\_qoc.\_grape module +========================= .. automodule:: qutip_qoc._grape - - - - - - - - - - - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._jopt.rst b/doc/apidoc/qutip_qoc._jopt.rst index 42a9477..fa6c03e 100644 --- a/doc/apidoc/qutip_qoc._jopt.rst +++ b/doc/apidoc/qutip_qoc._jopt.rst @@ -1,30 +1,8 @@ -qutip\_qoc.\_jopt -================= +qutip\_qoc.\_jopt module +======================== .. automodule:: qutip_qoc._jopt - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Dopri5 - PIDController - Qobj - QobjEvo - custom_jvp - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._optimizer.rst b/doc/apidoc/qutip_qoc._optimizer.rst index c05048e..8fc0ea1 100644 --- a/doc/apidoc/qutip_qoc._optimizer.rst +++ b/doc/apidoc/qutip_qoc._optimizer.rst @@ -1,27 +1,8 @@ -qutip\_qoc.\_optimizer -====================== +qutip\_qoc.\_optimizer module +============================= .. automodule:: qutip_qoc._optimizer - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - OptimizeResult - Result - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._time.rst b/doc/apidoc/qutip_qoc._time.rst index 922ebdc..fb7c6d5 100644 --- a/doc/apidoc/qutip_qoc._time.rst +++ b/doc/apidoc/qutip_qoc._time.rst @@ -1,20 +1,8 @@ -qutip\_qoc.\_time -================= +qutip\_qoc.\_time module +======================== .. automodule:: qutip_qoc._time - - - - - - - - - - - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc.objective.rst b/doc/apidoc/qutip_qoc.objective.rst index 1ba9e08..f7fa08f 100644 --- a/doc/apidoc/qutip_qoc.objective.rst +++ b/doc/apidoc/qutip_qoc.objective.rst @@ -1,26 +1,8 @@ -qutip\_qoc.objective -==================== +qutip\_qoc.objective module +=========================== .. automodule:: qutip_qoc.objective - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Objective - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc.pulse_optim.rst b/doc/apidoc/qutip_qoc.pulse_optim.rst index 25b4cdf..f78eeea 100644 --- a/doc/apidoc/qutip_qoc.pulse_optim.rst +++ b/doc/apidoc/qutip_qoc.pulse_optim.rst @@ -1,26 +1,8 @@ -qutip\_qoc.pulse\_optim -======================= +qutip\_qoc.pulse\_optim module +============================== .. automodule:: qutip_qoc.pulse_optim - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - optimize_pulses - - - - - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc.result.rst b/doc/apidoc/qutip_qoc.result.rst index 5e2eb5c..73ee021 100644 --- a/doc/apidoc/qutip_qoc.result.rst +++ b/doc/apidoc/qutip_qoc.result.rst @@ -1,32 +1,8 @@ -qutip\_qoc.result -================= +qutip\_qoc.result module +======================== .. automodule:: qutip_qoc.result - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - signature - - - - - - .. rubric:: Classes - - .. autosummary:: - - Result - - - - - - + :members: + :undoc-members: + :show-inheritance: + :private-members: