docs: Allow to have dropdown menu to show the API of reporters

sphinx/conf.py

@@ -94,7 +94,7 @@ def reset_mpl(gallery_conf, fname):
         # The module you locally document uses None
         "skore": None,
     },
-    "backreferences_dir": "generated",
+    "backreferences_dir": "reference/api",
     "doc_module": "skore",
     "reset_modules": (reset_mpl, "seaborn"),
     "abort_on_example_error": True,

sphinx/index.rst

@@ -58,5 +58,5 @@ Skore is just at the beginning of its journey, but we’re shipping fast! Freque
 
    install
    auto_examples/index
-   api
+   reference/index
    contributing_link

sphinx/reference/index.rst

@@ -0,0 +1,15 @@
+API
+===
+
+This page lists all the public functions and classes of the skore package.
+
+.. warning ::
+
+    This code is still in development. **The API is subject to change.**
+
+.. currentmodule:: skore
+
+.. toctree::
+   :maxdepth: 2
+
+   report

sphinx/reference/report.rst

@@ -0,0 +1,18 @@
+Report
+======
+
+.. currentmodule:: skore
+
+This section contains documentation for different types of reports available in skore.
+
+Single Estimator Report
+-----------------------
+
+The :doc:`report/estimator_report` provides comprehensive reporting capabilities for individual
+scikit-learn estimators, including metrics, visualizations, and evaluation tools.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   report/estimator_report

sphinx/reference/report/estimator_report.rst

@@ -0,0 +1,56 @@
+Report for a single estimator
+============================
+
+.. currentmodule:: skore
+
+The class :class:`EstimatorReport` provides a report allowing to inspect and
+evaluate a scikit-learn estimator in an interactive way. The functionalities of the
+report are accessible through accessors.
+
+.. autosummary::
+   :toctree: ../api/
+   :template: base.rst
+
+   EstimatorReport
+
+.. rubric:: Methods
+
+.. autosummary::
+   :toctree: ../api/
+   :template: autosummary/accessor_method.rst
+
+   EstimatorReport.help
+
+.. rubric:: Metrics
+
+.. autosummary::
+   :toctree: ../api/
+   :template: autosummary/accessor.rst
+
+   EstimatorReport.metrics
+
+Metrics
+-------
+
+The `metrics` accessor helps you to evaluate the statistical performance of your
+estimator.
+
+.. autosummary::
+    :toctree: ../api/
+    :nosignatures:
+    :template: autosummary/accessor_method.rst
+
+    EstimatorReport.metrics.help
+    EstimatorReport.metrics.report_metrics
+    EstimatorReport.metrics.custom_metric
+    EstimatorReport.metrics.accuracy
+    EstimatorReport.metrics.brier_score
+    EstimatorReport.metrics.log_loss
+    EstimatorReport.metrics.precision
+    EstimatorReport.metrics.precision_recall
+    EstimatorReport.metrics.prediction_error
+    EstimatorReport.metrics.r2
+    EstimatorReport.metrics.recall
+    EstimatorReport.metrics.rmse
+    EstimatorReport.metrics.roc
+    EstimatorReport.metrics.roc_auc