Use autosummary to generate a summary of API docs (#99)

* Use autosummary for the API doc * Manually optimize the API docs
qutip · Oct 13, 2021 · 6d4f07f · 6d4f07f
1 parent 527c3c8
commit 6d4f07f
Show file tree

Hide file tree

Showing 34 changed files with 347 additions and 316 deletions.
diff --git a/doc/source/_apidoc/qutip_qip.algorithms.rst b/doc/source/_apidoc/qutip_qip.algorithms.rst
diff --git a/doc/source/_apidoc/qutip_qip.compiler.rst b/doc/source/_apidoc/qutip_qip.compiler.rst
diff --git a/doc/source/_apidoc/qutip_qip.decompose.rst b/doc/source/_apidoc/qutip_qip.decompose.rst
diff --git a/doc/source/_apidoc/qutip_qip.device.rst b/doc/source/_apidoc/qutip_qip.device.rst
diff --git a/doc/source/_apidoc/qutip_qip.operations.rst b/doc/source/_apidoc/qutip_qip.operations.rst
diff --git a/doc/source/_apidoc/qutip_qip.rst b/doc/source/_apidoc/qutip_qip.rst
diff --git a/doc/source/_apidoc/qutip_qip.transpiler.rst b/doc/source/_apidoc/qutip_qip.transpiler.rst
diff --git a/doc/source/_templates/autosummary/module.rst b/doc/source/_templates/autosummary/module.rst
@@ -0,0 +1,50 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+   :members:
+   :show-inheritance:
+   :imported-members:
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/doc/source/apidoc.rst b/doc/source/apidoc.rst
@@ -0,0 +1,34 @@
+qutip\_qip package
+==================
+
+
+.. toctree::
+   :maxdepth: 1
+
+
+Operator-level simulation
+-------------------------
+Simulation based on operator-state multiplication.
+
+.. autosummary::
+   :toctree: apidoc/
+   :template: autosummary/module.rst
+
+   qutip_qip.circuit
+   qutip_qip.operations
+   qutip_qip.qubits
+   qutip_qip.decompose
+   qutip_qip.qasm
+
+Pulse-level simulation
+----------------------
+Simulation based on the master equation.
+
+.. autosummary::
+   :toctree: apidoc/
+   :template: autosummary/module.rst
+
+   qutip_qip.device
+   qutip_qip.compiler
+   qutip_qip.pulse
+   qutip_qip.noise