Skip to content

Commit

Permalink
remove toctree and template
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick committed May 26, 2024
1 parent 0e62c2c commit a9f7d67
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 218 deletions.
8 changes: 0 additions & 8 deletions doc/apidoc.rst
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -22,8 +18,6 @@ Utilities
Optimal control utility functions.

.. autosummary::
:toctree: apidoc/
:template: autosummary/module.rst

qutip_qoc.result
qutip_qoc.objective
Expand All @@ -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
Expand Down
24 changes: 6 additions & 18 deletions doc/apidoc/qutip_qoc._crab.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
qutip\_qoc.\_crab
=================
qutip\_qoc.\_crab module
========================

.. automodule:: qutip_qoc._crab
















:members:
:undoc-members:
:show-inheritance:
:private-members:
31 changes: 6 additions & 25 deletions doc/apidoc/qutip_qoc._goat.rst
Original file line number Diff line number Diff line change
@@ -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:
24 changes: 6 additions & 18 deletions doc/apidoc/qutip_qoc._grape.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
qutip\_qoc.\_grape
==================
qutip\_qoc.\_grape module
=========================

.. automodule:: qutip_qoc._grape
















:members:
:undoc-members:
:show-inheritance:
:private-members:
34 changes: 6 additions & 28 deletions doc/apidoc/qutip_qoc._jopt.rst
Original file line number Diff line number Diff line change
@@ -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:
31 changes: 6 additions & 25 deletions doc/apidoc/qutip_qoc._optimizer.rst
Original file line number Diff line number Diff line change
@@ -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:
24 changes: 6 additions & 18 deletions doc/apidoc/qutip_qoc._time.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
qutip\_qoc.\_time
=================
qutip\_qoc.\_time module
========================

.. automodule:: qutip_qoc._time
















:members:
:undoc-members:
:show-inheritance:
:private-members:
30 changes: 6 additions & 24 deletions doc/apidoc/qutip_qoc.objective.rst
Original file line number Diff line number Diff line change
@@ -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:
30 changes: 6 additions & 24 deletions doc/apidoc/qutip_qoc.pulse_optim.rst
Original file line number Diff line number Diff line change
@@ -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:
36 changes: 6 additions & 30 deletions doc/apidoc/qutip_qoc.result.rst
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit a9f7d67

Please sign in to comment.