From 3248a69c28105f8d64a0a2a9e201875954721cbd Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:12:23 +0200 Subject: [PATCH 01/12] remove apidoc from gitignore --- .gitignore | 1 - doc/apidoc/modules.rst | 7 +++++++ doc/apidoc/qutip_qoc._crab.rst | 6 ++++++ doc/apidoc/qutip_qoc._goat.rst | 6 ++++++ doc/apidoc/qutip_qoc._grape.rst | 6 ++++++ doc/apidoc/qutip_qoc._jopt.rst | 6 ++++++ doc/apidoc/qutip_qoc._optimizer.rst | 6 ++++++ doc/apidoc/qutip_qoc._time.rst | 6 ++++++ doc/apidoc/qutip_qoc.objective.rst | 6 ++++++ doc/apidoc/qutip_qoc.pulse_optim.rst | 6 ++++++ doc/apidoc/qutip_qoc.result.rst | 6 ++++++ doc/apidoc/qutip_qoc.rst | 28 ++++++++++++++++++++++++++++ doc/apidoc/qutip_qoc.version.rst | 8 ++++++++ 13 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 doc/apidoc/modules.rst create mode 100644 doc/apidoc/qutip_qoc._crab.rst create mode 100644 doc/apidoc/qutip_qoc._goat.rst create mode 100644 doc/apidoc/qutip_qoc._grape.rst create mode 100644 doc/apidoc/qutip_qoc._jopt.rst create mode 100644 doc/apidoc/qutip_qoc._optimizer.rst create mode 100644 doc/apidoc/qutip_qoc._time.rst create mode 100644 doc/apidoc/qutip_qoc.objective.rst create mode 100644 doc/apidoc/qutip_qoc.pulse_optim.rst create mode 100644 doc/apidoc/qutip_qoc.result.rst create mode 100644 doc/apidoc/qutip_qoc.rst create mode 100644 doc/apidoc/qutip_qoc.version.rst diff --git a/.gitignore b/.gitignore index 2ff1cc5..3335d46 100644 --- a/.gitignore +++ b/.gitignore @@ -29,7 +29,6 @@ MANIFEST src/qutip_qoc/version.py # Documentation -doc/apidoc/*.rst doc/.DS_Store # PyInstaller diff --git a/doc/apidoc/modules.rst b/doc/apidoc/modules.rst new file mode 100644 index 0000000..12bbc7e --- /dev/null +++ b/doc/apidoc/modules.rst @@ -0,0 +1,7 @@ +qutip_qoc +========= + +.. toctree:: + :maxdepth: 4 + + qutip_qoc diff --git a/doc/apidoc/qutip_qoc._crab.rst b/doc/apidoc/qutip_qoc._crab.rst new file mode 100644 index 0000000..7bee340 --- /dev/null +++ b/doc/apidoc/qutip_qoc._crab.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_crab +================= + +.. currentmodule:: qutip_qoc + +.. automodule:: _crab \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc._goat.rst b/doc/apidoc/qutip_qoc._goat.rst new file mode 100644 index 0000000..d12b41f --- /dev/null +++ b/doc/apidoc/qutip_qoc._goat.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_goat +================= + +.. currentmodule:: qutip_qoc + +.. automodule:: _goat \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc._grape.rst b/doc/apidoc/qutip_qoc._grape.rst new file mode 100644 index 0000000..616dc5a --- /dev/null +++ b/doc/apidoc/qutip_qoc._grape.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_grape +================== + +.. currentmodule:: qutip_qoc + +.. automodule:: _grape \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc._jopt.rst b/doc/apidoc/qutip_qoc._jopt.rst new file mode 100644 index 0000000..2600f2a --- /dev/null +++ b/doc/apidoc/qutip_qoc._jopt.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_jopt +================= + +.. currentmodule:: qutip_qoc + +.. automodule:: _jopt \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc._optimizer.rst b/doc/apidoc/qutip_qoc._optimizer.rst new file mode 100644 index 0000000..96e0491 --- /dev/null +++ b/doc/apidoc/qutip_qoc._optimizer.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_optimizer +====================== + +.. currentmodule:: qutip_qoc + +.. automodule:: _optimizer \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc._time.rst b/doc/apidoc/qutip_qoc._time.rst new file mode 100644 index 0000000..b3a1602 --- /dev/null +++ b/doc/apidoc/qutip_qoc._time.rst @@ -0,0 +1,6 @@ +qutip\_qoc.\_time +================= + +.. currentmodule:: qutip_qoc + +.. automodule:: _time \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc.objective.rst b/doc/apidoc/qutip_qoc.objective.rst new file mode 100644 index 0000000..2d276b9 --- /dev/null +++ b/doc/apidoc/qutip_qoc.objective.rst @@ -0,0 +1,6 @@ +qutip\_qoc.objective +==================== + +.. currentmodule:: qutip_qoc + +.. automodule:: objective \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc.pulse_optim.rst b/doc/apidoc/qutip_qoc.pulse_optim.rst new file mode 100644 index 0000000..21739db --- /dev/null +++ b/doc/apidoc/qutip_qoc.pulse_optim.rst @@ -0,0 +1,6 @@ +qutip\_qoc.pulse\_optim +======================= + +.. currentmodule:: qutip_qoc + +.. automodule:: pulse_optim \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc.result.rst b/doc/apidoc/qutip_qoc.result.rst new file mode 100644 index 0000000..0b243cb --- /dev/null +++ b/doc/apidoc/qutip_qoc.result.rst @@ -0,0 +1,6 @@ +qutip\_qoc.result +================= + +.. currentmodule:: qutip_qoc + +.. automodule:: result \ No newline at end of file diff --git a/doc/apidoc/qutip_qoc.rst b/doc/apidoc/qutip_qoc.rst new file mode 100644 index 0000000..e6438b6 --- /dev/null +++ b/doc/apidoc/qutip_qoc.rst @@ -0,0 +1,28 @@ +qutip\_qoc package +================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + qutip_qoc._crab + qutip_qoc._goat + qutip_qoc._grape + qutip_qoc._jopt + qutip_qoc._optimizer + qutip_qoc._time + qutip_qoc.objective + qutip_qoc.pulse_optim + qutip_qoc.result + qutip_qoc.version + +Module contents +--------------- + +.. automodule:: qutip_qoc + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc.version.rst b/doc/apidoc/qutip_qoc.version.rst new file mode 100644 index 0000000..7d12069 --- /dev/null +++ b/doc/apidoc/qutip_qoc.version.rst @@ -0,0 +1,8 @@ +qutip\_qoc.version module +========================= + +.. automodule:: qutip_qoc.version + :members: + :undoc-members: + :show-inheritance: + :private-members: From ff0476a15a6fbda88bac4a75648e46df2447aa2c Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:23:55 +0200 Subject: [PATCH 02/12] remove pdf format --- .readthedocs.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 8b35d12..1c6fcac 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,13 +4,10 @@ version: 2 -formats: - - pdf - build: os: ubuntu-22.04 tools: - python: "mambaforge-4.10" + python: "conda" conda: environment: doc/rtd-environment.yml From 85c7a9056dd8a6e112c3048f4cfdca1b3669a4ff Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:25:43 +0200 Subject: [PATCH 03/12] fix rtd pyhton version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1c6fcac..f08eaf0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "conda" + python: "3.11" conda: environment: doc/rtd-environment.yml From 415408476ff59131497fda8cec52fae5986d115d Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:33:08 +0200 Subject: [PATCH 04/12] add python version to dependencies --- .readthedocs.yaml | 2 +- doc/rtd-environment.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f08eaf0..1c6fcac 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "conda" conda: environment: doc/rtd-environment.yml diff --git a/doc/rtd-environment.yml b/doc/rtd-environment.yml index d2e31c3..062394a 100644 --- a/doc/rtd-environment.yml +++ b/doc/rtd-environment.yml @@ -2,6 +2,7 @@ name: rtd-environment channels: - conda-forge dependencies: + - python=3.11 - numpy>=1.16.6 - scipy>=1.10.1 - cython>=0.29.33 From 68a262b7a8fecdb42422515e36e3e241db99ffc3 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:46:03 +0200 Subject: [PATCH 05/12] Revert "add python version to dependencies" This reverts commit 415408476ff59131497fda8cec52fae5986d115d. --- .readthedocs.yaml | 2 +- doc/rtd-environment.yml | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1c6fcac..f08eaf0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "conda" + python: "3.11" conda: environment: doc/rtd-environment.yml diff --git a/doc/rtd-environment.yml b/doc/rtd-environment.yml index 062394a..d2e31c3 100644 --- a/doc/rtd-environment.yml +++ b/doc/rtd-environment.yml @@ -2,7 +2,6 @@ name: rtd-environment channels: - conda-forge dependencies: - - python=3.11 - numpy>=1.16.6 - scipy>=1.10.1 - cython>=0.29.33 From 96b23453457a2fbbe74bc05c12dec9f2046f59b3 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:47:16 +0200 Subject: [PATCH 06/12] Revert "fix rtd pyhton version" This reverts commit 85c7a9056dd8a6e112c3048f4cfdca1b3669a4ff. --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f08eaf0..1c6fcac 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "conda" conda: environment: doc/rtd-environment.yml From 7598d1c292bdf3264e6e09bd5693f9ffcae82ec0 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 20:49:36 +0200 Subject: [PATCH 07/12] revert changes --- .readthedocs.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1c6fcac..c5e1295 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,14 +4,17 @@ version: 2 +formats: + - pdf + build: os: ubuntu-22.04 tools: - python: "conda" + python: "mambaforge-4.10" conda: environment: doc/rtd-environment.yml sphinx: configuration: doc/conf.py - fail_on_warning: false + fail_on_warning: true \ No newline at end of file From a5b7608fa00daabf49854f4158c14638ff980992 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 21:07:40 +0200 Subject: [PATCH 08/12] remove sys path --- .readthedocs.yaml | 2 +- doc/apidoc/qutip_qoc._crab.rst | 2 +- doc/apidoc/qutip_qoc._goat.rst | 2 +- doc/apidoc/qutip_qoc._grape.rst | 2 +- doc/apidoc/qutip_qoc._jopt.rst | 2 +- doc/apidoc/qutip_qoc._optimizer.rst | 2 +- doc/apidoc/qutip_qoc._time.rst | 2 +- doc/apidoc/qutip_qoc.objective.rst | 2 +- doc/apidoc/qutip_qoc.pulse_optim.rst | 2 +- doc/apidoc/qutip_qoc.result.rst | 2 +- doc/conf.py | 6 ------ 11 files changed, 10 insertions(+), 16 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c5e1295..9624762 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,4 +17,4 @@ conda: sphinx: configuration: doc/conf.py - fail_on_warning: true \ No newline at end of file + fail_on_warning: true diff --git a/doc/apidoc/qutip_qoc._crab.rst b/doc/apidoc/qutip_qoc._crab.rst index 7bee340..622195a 100644 --- a/doc/apidoc/qutip_qoc._crab.rst +++ b/doc/apidoc/qutip_qoc._crab.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _crab \ No newline at end of file +.. automodule:: _crab diff --git a/doc/apidoc/qutip_qoc._goat.rst b/doc/apidoc/qutip_qoc._goat.rst index d12b41f..d904e99 100644 --- a/doc/apidoc/qutip_qoc._goat.rst +++ b/doc/apidoc/qutip_qoc._goat.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _goat \ No newline at end of file +.. automodule:: _goat diff --git a/doc/apidoc/qutip_qoc._grape.rst b/doc/apidoc/qutip_qoc._grape.rst index 616dc5a..00234d6 100644 --- a/doc/apidoc/qutip_qoc._grape.rst +++ b/doc/apidoc/qutip_qoc._grape.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _grape \ No newline at end of file +.. automodule:: _grape diff --git a/doc/apidoc/qutip_qoc._jopt.rst b/doc/apidoc/qutip_qoc._jopt.rst index 2600f2a..2033c83 100644 --- a/doc/apidoc/qutip_qoc._jopt.rst +++ b/doc/apidoc/qutip_qoc._jopt.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _jopt \ No newline at end of file +.. automodule:: _jopt diff --git a/doc/apidoc/qutip_qoc._optimizer.rst b/doc/apidoc/qutip_qoc._optimizer.rst index 96e0491..c913eff 100644 --- a/doc/apidoc/qutip_qoc._optimizer.rst +++ b/doc/apidoc/qutip_qoc._optimizer.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _optimizer \ No newline at end of file +.. automodule:: _optimizer diff --git a/doc/apidoc/qutip_qoc._time.rst b/doc/apidoc/qutip_qoc._time.rst index b3a1602..8000d5b 100644 --- a/doc/apidoc/qutip_qoc._time.rst +++ b/doc/apidoc/qutip_qoc._time.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: _time \ No newline at end of file +.. automodule:: _time diff --git a/doc/apidoc/qutip_qoc.objective.rst b/doc/apidoc/qutip_qoc.objective.rst index 2d276b9..c192463 100644 --- a/doc/apidoc/qutip_qoc.objective.rst +++ b/doc/apidoc/qutip_qoc.objective.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: objective \ No newline at end of file +.. automodule:: objective diff --git a/doc/apidoc/qutip_qoc.pulse_optim.rst b/doc/apidoc/qutip_qoc.pulse_optim.rst index 21739db..eac12d9 100644 --- a/doc/apidoc/qutip_qoc.pulse_optim.rst +++ b/doc/apidoc/qutip_qoc.pulse_optim.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: pulse_optim \ No newline at end of file +.. automodule:: pulse_optim diff --git a/doc/apidoc/qutip_qoc.result.rst b/doc/apidoc/qutip_qoc.result.rst index 0b243cb..82ca8c3 100644 --- a/doc/apidoc/qutip_qoc.result.rst +++ b/doc/apidoc/qutip_qoc.result.rst @@ -3,4 +3,4 @@ .. currentmodule:: qutip_qoc -.. automodule:: result \ No newline at end of file +.. automodule:: result diff --git a/doc/conf.py b/doc/conf.py index 7e60313..fe399ce 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -9,13 +9,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -import os import pathlib -import sys - -sys.path.insert(0, os.path.abspath(".")) -sys.path.insert(0, os.path.abspath("../src")) -sys.path.insert(0, os.path.abspath("../src/qutip_qoc")) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 1926f406a17ee679687ba17cf4fe4db259892217 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 21:24:05 +0200 Subject: [PATCH 09/12] add modules to prevent warning --- doc/apidoc.rst | 5 +++++ doc/conf.py | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/doc/apidoc.rst b/doc/apidoc.rst index 90a0993..6360a2f 100644 --- a/doc/apidoc.rst +++ b/doc/apidoc.rst @@ -42,3 +42,8 @@ Internal interfaces to the optimal control features. qutip_qoc._grape qutip_qoc._crab qutip_qoc._time + +.. toctree:: + :maxdepth: 2 + + apidoc/modules diff --git a/doc/conf.py b/doc/conf.py index fe399ce..ab65dc7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -9,7 +9,11 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +import os import pathlib +import sys + +sys.path.insert(0, os.path.abspath("../src/qutip_qoc")) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 6ee0aa8d8916961f6c41c548d4dbf314d0d48f0f Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 21:55:39 +0200 Subject: [PATCH 10/12] change template --- doc/apidoc.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/apidoc.rst b/doc/apidoc.rst index 6360a2f..02f08a6 100644 --- a/doc/apidoc.rst +++ b/doc/apidoc.rst @@ -12,7 +12,7 @@ High-level interfaces to the optimal control features. .. autosummary:: :toctree: apidoc/ - :template: apidoc/module.rst + :template: autosummary/module.rst qutip_qoc.pulse_optim @@ -23,7 +23,7 @@ Optimal control utility functions. .. autosummary:: :toctree: apidoc/ - :template: apidoc/module.rst + :template: autosummary/module.rst qutip_qoc.result qutip_qoc.objective @@ -34,7 +34,7 @@ Internal interfaces to the optimal control features. .. autosummary:: :toctree: apidoc/ - :template: apidoc/module.rst + :template: autosummary/module.rst qutip_qoc._optimizer qutip_qoc._goat @@ -44,6 +44,6 @@ Internal interfaces to the optimal control features. qutip_qoc._time .. toctree:: - :maxdepth: 2 + :hidden: apidoc/modules From 0e62c2c1194e04fdea2f3a55513dbbe3d9e221cc Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 22 May 2024 22:04:44 +0200 Subject: [PATCH 11/12] altered template apidocs --- doc/apidoc/qutip_qoc._crab.rst | 18 +++++++++++++++-- doc/apidoc/qutip_qoc._goat.rst | 25 +++++++++++++++++++++-- doc/apidoc/qutip_qoc._grape.rst | 18 +++++++++++++++-- doc/apidoc/qutip_qoc._jopt.rst | 28 ++++++++++++++++++++++++-- doc/apidoc/qutip_qoc._optimizer.rst | 25 +++++++++++++++++++++-- doc/apidoc/qutip_qoc._time.rst | 18 +++++++++++++++-- doc/apidoc/qutip_qoc.objective.rst | 24 ++++++++++++++++++++-- doc/apidoc/qutip_qoc.pulse_optim.rst | 24 ++++++++++++++++++++-- doc/apidoc/qutip_qoc.result.rst | 30 ++++++++++++++++++++++++++-- 9 files changed, 192 insertions(+), 18 deletions(-) diff --git a/doc/apidoc/qutip_qoc._crab.rst b/doc/apidoc/qutip_qoc._crab.rst index 622195a..0dfe827 100644 --- a/doc/apidoc/qutip_qoc._crab.rst +++ b/doc/apidoc/qutip_qoc._crab.rst @@ -1,6 +1,20 @@ qutip\_qoc.\_crab ================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._crab + + + + + + + + + + + + + + + -.. automodule:: _crab diff --git a/doc/apidoc/qutip_qoc._goat.rst b/doc/apidoc/qutip_qoc._goat.rst index d904e99..93e225d 100644 --- a/doc/apidoc/qutip_qoc._goat.rst +++ b/doc/apidoc/qutip_qoc._goat.rst @@ -1,6 +1,27 @@ qutip\_qoc.\_goat ================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._goat + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Qobj + QobjEvo + + + + + -.. automodule:: _goat diff --git a/doc/apidoc/qutip_qoc._grape.rst b/doc/apidoc/qutip_qoc._grape.rst index 00234d6..8097575 100644 --- a/doc/apidoc/qutip_qoc._grape.rst +++ b/doc/apidoc/qutip_qoc._grape.rst @@ -1,6 +1,20 @@ qutip\_qoc.\_grape ================== -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._grape + + + + + + + + + + + + + + + -.. automodule:: _grape diff --git a/doc/apidoc/qutip_qoc._jopt.rst b/doc/apidoc/qutip_qoc._jopt.rst index 2033c83..42a9477 100644 --- a/doc/apidoc/qutip_qoc._jopt.rst +++ b/doc/apidoc/qutip_qoc._jopt.rst @@ -1,6 +1,30 @@ qutip\_qoc.\_jopt ================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._jopt + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Dopri5 + PIDController + Qobj + QobjEvo + custom_jvp + + + + + -.. automodule:: _jopt diff --git a/doc/apidoc/qutip_qoc._optimizer.rst b/doc/apidoc/qutip_qoc._optimizer.rst index c913eff..c05048e 100644 --- a/doc/apidoc/qutip_qoc._optimizer.rst +++ b/doc/apidoc/qutip_qoc._optimizer.rst @@ -1,6 +1,27 @@ qutip\_qoc.\_optimizer ====================== -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._optimizer + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + OptimizeResult + Result + + + + + -.. automodule:: _optimizer diff --git a/doc/apidoc/qutip_qoc._time.rst b/doc/apidoc/qutip_qoc._time.rst index 8000d5b..922ebdc 100644 --- a/doc/apidoc/qutip_qoc._time.rst +++ b/doc/apidoc/qutip_qoc._time.rst @@ -1,6 +1,20 @@ qutip\_qoc.\_time ================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc._time + + + + + + + + + + + + + + + -.. automodule:: _time diff --git a/doc/apidoc/qutip_qoc.objective.rst b/doc/apidoc/qutip_qoc.objective.rst index c192463..1ba9e08 100644 --- a/doc/apidoc/qutip_qoc.objective.rst +++ b/doc/apidoc/qutip_qoc.objective.rst @@ -1,6 +1,26 @@ qutip\_qoc.objective ==================== -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc.objective + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Objective + + + + + -.. automodule:: objective diff --git a/doc/apidoc/qutip_qoc.pulse_optim.rst b/doc/apidoc/qutip_qoc.pulse_optim.rst index eac12d9..25b4cdf 100644 --- a/doc/apidoc/qutip_qoc.pulse_optim.rst +++ b/doc/apidoc/qutip_qoc.pulse_optim.rst @@ -1,6 +1,26 @@ qutip\_qoc.pulse\_optim ======================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc.pulse_optim + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + optimize_pulses + + + + + + + + + -.. automodule:: pulse_optim diff --git a/doc/apidoc/qutip_qoc.result.rst b/doc/apidoc/qutip_qoc.result.rst index 82ca8c3..5e2eb5c 100644 --- a/doc/apidoc/qutip_qoc.result.rst +++ b/doc/apidoc/qutip_qoc.result.rst @@ -1,6 +1,32 @@ qutip\_qoc.result ================= -.. currentmodule:: qutip_qoc +.. automodule:: qutip_qoc.result + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + signature + + + + + + .. rubric:: Classes + + .. autosummary:: + + Result + + + + + -.. automodule:: result From a9f7d674df5ea2c7296f2d4e03dd5719fe0cda59 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Sun, 26 May 2024 09:28:55 +0200 Subject: [PATCH 12/12] 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: