drop ScatterTable from toctree

nkanazawa1989 · Sep 13, 2023 · 7b114de · 7b114de
1 parent d64f461
commit 7b114de
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/qiskit_experiments/curve_analysis/__init__.py b/qiskit_experiments/curve_analysis/__init__.py
@@ -44,7 +44,6 @@
     CurveFitResult
     ParameterRepr
     FitOptions
-    ScatterTable
 
 Visualization
 =============

diff --git a/qiskit_experiments/curve_analysis/scatter_table.py b/qiskit_experiments/curve_analysis/scatter_table.py
@@ -45,6 +45,10 @@ class ScatterTable(pd.DataFrame, DefaultColumnsMixIn):
 
     """
 
+    # TODO Add this to toctree. In current mechanism all pandas DataFrame members are rendered
+    #  and it fails in the Sphinx build process. We may need a custom directive to
+    #  exclude class members from an external package.
+
     @classmethod
     def _default_columns(cls) -> List[str]:
         return [