Merge pull request #511 from qiboteam/new_layout_doc

Standardize documentation for new layout
qiboteam · Sep 8, 2023 · 73ec9f0 · 73ec9f0
2 parents 00d27e0 + aff5c62
commit 73ec9f0
Show file tree

Hide file tree

Showing 45 changed files with 1,049 additions and 1,118 deletions.
diff --git a/doc/source/_static/qibo_logo_dark.svg b/doc/source/_static/qibo_logo_dark.svg
diff --git a/doc/source/_static/qibo_logo_light.svg b/doc/source/_static/qibo_logo_light.svg
diff --git a/doc/source/api-reference/index.rst b/doc/source/api-reference/index.rst
diff --git a/doc/source/api-reference/lorentzian_fit_result.png b/doc/source/api-reference/lorentzian_fit_result.png
diff --git a/doc/source/api-reference/modules.rst b/doc/source/api-reference/modules.rst
@@ -0,0 +1,12 @@
+.. _Components:
+
+API reference
+=============
+
+In this section we present the main Qibolab components and primitives included in the public API.
+
+
+.. toctree::
+   :maxdepth: 3
+
+   qibocal
diff --git a/doc/source/api-reference/qibocal.auto.rst b/doc/source/api-reference/qibocal.auto.rst
@@ -0,0 +1,82 @@
+qibocal.auto package
+====================
+
+.. automodule:: qibocal.auto
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+qibocal.auto.draw module
+------------------------
+
+.. automodule:: qibocal.auto.draw
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.execute module
+---------------------------
+
+.. automodule:: qibocal.auto.execute
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.graph module
+-------------------------
+
+.. automodule:: qibocal.auto.graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.history module
+---------------------------
+
+.. automodule:: qibocal.auto.history
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.operation module
+-----------------------------
+
+.. automodule:: qibocal.auto.operation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.runcard module
+---------------------------
+
+.. automodule:: qibocal.auto.runcard
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.status module
+--------------------------
+
+.. automodule:: qibocal.auto.status
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.task module
+------------------------
+
+.. automodule:: qibocal.auto.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.auto.validate module
+----------------------------
+
+.. automodule:: qibocal.auto.validate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/api-reference/qibocal.cli.rst b/doc/source/api-reference/qibocal.cli.rst
@@ -0,0 +1,26 @@
+qibocal.cli package
+===================
+
+.. automodule:: qibocal.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+qibocal.cli.builders module
+---------------------------
+
+.. automodule:: qibocal.cli.builders
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.cli.utils module
+------------------------
+
+.. automodule:: qibocal.cli.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/api-reference/qibocal.protocols.characterization.allxy.rst b/doc/source/api-reference/qibocal.protocols.characterization.allxy.rst
@@ -0,0 +1,34 @@
+qibocal.protocols.characterization.allxy package
+================================================
+
+.. automodule:: qibocal.protocols.characterization.allxy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+qibocal.protocols.characterization.allxy.allxy module
+-----------------------------------------------------
+
+.. automodule:: qibocal.protocols.characterization.allxy.allxy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.protocols.characterization.allxy.allxy\_drag\_pulse\_tuning module
+--------------------------------------------------------------------------
+
+.. automodule:: qibocal.protocols.characterization.allxy.allxy_drag_pulse_tuning
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qibocal.protocols.characterization.allxy.drag\_pulse\_tuning module
+-------------------------------------------------------------------
+
+.. automodule:: qibocal.protocols.characterization.allxy.drag_pulse_tuning
+   :members:
+   :undoc-members:
+   :show-inheritance: