added (#1978)

Qiskit · Oct 17, 2024 · ce3d7a2 · ce3d7a2
1 parent 689c64e
commit ce3d7a2
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -155,7 +155,7 @@ Finally, preview the docs build by following the instructions in
 Building The release notes are part of the standard qiskit-ibm-runtime
 documentation builds. To check what the rendered html output of the release
 notes will look like for the current state of the repo you can run:
-`tox -edocs` which will build all the documentation into `docs/_build/html`
+`tox -e docs` which will build all the documentation into `docs/_build/html`
 and the release notes in particular will be located at
 `docs/_build/html/release_notes.html`.
 

diff --git a/docs/apidocs/debug_tools.rst b/docs/apidocs/debug_tools.rst
@@ -0,0 +1,4 @@
+.. automodule:: qiskit_ibm_runtime.debug_tools
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -15,4 +15,5 @@ qiskit-ibm-runtime API reference
    qiskit_ibm_runtime.transpiler.passes.scheduling
    fake_provider
    execution_span
+   debug_tools
    visualization
diff --git a/qiskit_ibm_runtime/debug_tools/__init__.py b/qiskit_ibm_runtime/debug_tools/__init__.py
@@ -10,7 +10,26 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""Functions and classes for debugging and analyzing qiskit-ibm-runtime jobs."""
+"""
+=======================================================
+Debugging tools (:mod:`qiskit_ibm_runtime.debug_tools`)
+=======================================================
+
+.. currentmodule:: qiskit_ibm_runtime.debug_tools
+
+The tools for debugging and analyzing qiskit-ibm-runtime jobs.
+
+Classes
+=======
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   Neat
+   NeatResult
+   NeatPubResult
+
+"""
 
 from .neat import Neat
 from .neat_results import NeatPubResult, NeatResult