Break up options classes in docs (#1806)

* break up options classes * use lower case
Qiskit · Jul 19, 2024 · 7b81be4 · 7b81be4
1 parent 55d0abb
commit 7b81be4
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 7 deletions.
diff --git a/qiskit_ibm_runtime/options/__init__.py b/qiskit_ibm_runtime/options/__init__.py
@@ -17,7 +17,7 @@
 
 .. currentmodule:: qiskit_ibm_runtime.options
 
-Options that can be passed to the primitives.
+Options that can be passed to the Qiskit Runtime primitives.
 
 V2 Primitives
 =============
@@ -75,11 +75,23 @@
 Classes
 =======
 
+Base primitive options
+----------------------
+
 .. autosummary::
    :toctree: ../stubs/
 
    EstimatorOptions
    SamplerOptions
+   Options
+
+
+Suboptions for V2 primitives only
+---------------------------------
+
+.. autosummary::
+   :toctree: ../stubs/
+
    DynamicalDecouplingOptions
    ResilienceOptionsV2
    LayerNoiseLearningOptions
@@ -88,13 +100,28 @@
    ZneOptions
    TwirlingOptions
    ExecutionOptionsV2
-   Options
-   TranspilationOptions
-   ResilienceOptions
-   ExecutionOptions
+   SamplerExecutionOptionsV2
+
+
+Suboptions for both V1 and V2 primitives
+----------------------------------------
+
+.. autosummary::
+   :toctree: ../stubs/
+
    EnvironmentOptions
    SimulatorOptions
-   SamplerExecutionOptionsV2
+
+
+Suboptions for V1 primitives only
+---------------------------------
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   TranspilationOptions
+   ExecutionOptions
+   ResilienceOptions
 
 """
 

diff --git a/qiskit_ibm_runtime/options/options.py b/qiskit_ibm_runtime/options/options.py
@@ -233,7 +233,7 @@ def _set_if_exists(name: str, _inputs: dict, _options: dict) -> None:
 
 @dataclass
 class Options(BaseOptions):
-    """Options for the primitives, used by V1 primitives.
+    """Options for V1 primitives.
 
     Args:
         optimization_level: How much optimization to perform on the circuits.