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/.readthedocs.yaml b/.readthedocs.yaml index 8b35d12..9624762 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,4 +17,4 @@ conda: sphinx: configuration: doc/conf.py - fail_on_warning: false + fail_on_warning: true diff --git a/doc/apidoc.rst b/doc/apidoc.rst index 90a0993..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: apidoc/module.rst qutip_qoc.pulse_optim @@ -22,8 +18,6 @@ Utilities Optimal control utility functions. .. autosummary:: - :toctree: apidoc/ - :template: apidoc/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: apidoc/module.rst qutip_qoc._optimizer qutip_qoc._goat @@ -42,3 +34,8 @@ Internal interfaces to the optimal control features. qutip_qoc._grape qutip_qoc._crab qutip_qoc._time + +.. toctree:: + :hidden: + + apidoc/modules 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..5f0297e --- /dev/null +++ b/doc/apidoc/qutip_qoc._crab.rst @@ -0,0 +1,8 @@ +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 new file mode 100644 index 0000000..d79a83f --- /dev/null +++ b/doc/apidoc/qutip_qoc._goat.rst @@ -0,0 +1,8 @@ +qutip\_qoc.\_goat module +======================== + +.. automodule:: qutip_qoc._goat + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._grape.rst b/doc/apidoc/qutip_qoc._grape.rst new file mode 100644 index 0000000..2ab0c2b --- /dev/null +++ b/doc/apidoc/qutip_qoc._grape.rst @@ -0,0 +1,8 @@ +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 new file mode 100644 index 0000000..fa6c03e --- /dev/null +++ b/doc/apidoc/qutip_qoc._jopt.rst @@ -0,0 +1,8 @@ +qutip\_qoc.\_jopt module +======================== + +.. automodule:: qutip_qoc._jopt + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._optimizer.rst b/doc/apidoc/qutip_qoc._optimizer.rst new file mode 100644 index 0000000..8fc0ea1 --- /dev/null +++ b/doc/apidoc/qutip_qoc._optimizer.rst @@ -0,0 +1,8 @@ +qutip\_qoc.\_optimizer module +============================= + +.. automodule:: qutip_qoc._optimizer + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc._time.rst b/doc/apidoc/qutip_qoc._time.rst new file mode 100644 index 0000000..fb7c6d5 --- /dev/null +++ b/doc/apidoc/qutip_qoc._time.rst @@ -0,0 +1,8 @@ +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 new file mode 100644 index 0000000..f7fa08f --- /dev/null +++ b/doc/apidoc/qutip_qoc.objective.rst @@ -0,0 +1,8 @@ +qutip\_qoc.objective module +=========================== + +.. automodule:: qutip_qoc.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 new file mode 100644 index 0000000..f78eeea --- /dev/null +++ b/doc/apidoc/qutip_qoc.pulse_optim.rst @@ -0,0 +1,8 @@ +qutip\_qoc.pulse\_optim module +============================== + +.. automodule:: qutip_qoc.pulse_optim + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/doc/apidoc/qutip_qoc.result.rst b/doc/apidoc/qutip_qoc.result.rst new file mode 100644 index 0000000..73ee021 --- /dev/null +++ b/doc/apidoc/qutip_qoc.result.rst @@ -0,0 +1,8 @@ +qutip\_qoc.result module +======================== + +.. automodule:: qutip_qoc.result + :members: + :undoc-members: + :show-inheritance: + :private-members: 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: diff --git a/doc/conf.py b/doc/conf.py index 7e60313..ab65dc7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -13,8 +13,6 @@ 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 -----------------------------------------------------