scikit-learn · Charlie-XIAO · Apr 11, 2024 · Feb 14, 2024 · Feb 15, 2024 · Feb 15, 2024
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ dist/
 MANIFEST
 doc/sg_execution_times.rst
 doc/_build/
+doc/api/*.rst
 doc/auto_examples/
 doc/css/*
 !doc/css/.gitkeep

diff --git a/build_tools/circle/build_doc.sh b/build_tools/circle/build_doc.sh
@@ -241,7 +241,7 @@ then
     (
     echo '<html><body><ul>'
     echo "$affected" | sed 's|.*|<li><a href="&">&</a> [<a href="https://scikit-learn.org/dev/&">dev</a>, <a href="https://scikit-learn.org/stable/&">stable</a>]</li>|'
-    echo '</ul><p>General: <a href="index.html">Home</a> | <a href="modules/classes.html">API Reference</a> | <a href="auto_examples/index.html">Examples</a></p>'
+    echo '</ul><p>General: <a href="index.html">Home</a> | <a href="api/index.html">API Reference</a> | <a href="auto_examples/index.html">Examples</a></p>'
     echo '<strong>Sphinx Warnings in affected files</strong><ul>'
     echo "$warnings" | sed 's/\/home\/circleci\/project\//<li>/g'
     echo '</ul></body></html>'

diff --git a/doc/Makefile b/doc/Makefile
@@ -51,6 +51,7 @@ clean:
 	-rm -rf generated/*
 	-rm -rf modules/generated/
 	-rm -rf css/styles/
+	-rm -rf api/*.rst
 
 # Default to SPHINX_NUMJOBS=1 for full documentation build. Using
 # SPHINX_NUMJOBS!=1 may actually slow down the build, or cause weird issues in

diff --git a/doc/api/deprecated.rst.template b/doc/api/deprecated.rst.template
@@ -0,0 +1,24 @@
+:html_theme.sidebar_secondary.remove:
+
+.. _api_depr_ref:
+
+Recently Deprecated
+===================
+
+.. currentmodule:: sklearn
+
+{% for ver, objs in DEPRECATED_API_REFERENCE %}
+.. _api_depr_ref-{{ ver|replace(".", "-") }}:
+
+.. rubric:: To be removed in {{ ver }}
+
+.. autosummary::
+  :nosignatures:
+  :toctree: ../modules/generated/
+  :template: base.rst
+
+{% for obj in objs %}
+  {{ obj }}
+{%- endfor %}
+
+{% endfor %}
diff --git a/doc/api/index.rst.template b/doc/api/index.rst.template
@@ -0,0 +1,77 @@
+:html_theme.sidebar_secondary.remove:
+
+.. _api_ref:
+
+=============
+API Reference
+=============
+
+This is the class and function reference of scikit-learn. Please refer to the
+:ref:`full user guide <user_guide>` for further details, as the raw specifications of
+classes and functions may not be enough to give full guidelines on their uses. For
+reference on concepts repeated across the API, see :ref:`glossary`.
+
+.. toctree::
+  :maxdepth: 2
+  :hidden:
+
+{% for module, _ in API_REFERENCE %}
+  {{ module }}
+{%- endfor %}
+{%- if DEPRECATED_API_REFERENCE %}
+  deprecated
+{%- endif %}
+
+.. list-table::
+  :header-rows: 1
+  :class: apisearch-table
+
+  * - Object
+    - Description
+
+{% for module, module_info in API_REFERENCE %}
+{% for section in module_info["sections"] %}
+{% for obj in section["autosummary"] %}
+{% set parts = obj.rsplit(".", 1) %}
+{% if parts|length > 1 %}
+{% set full_module = module + "." + parts[0] %}
+{% else %}
+{% set full_module = module %}
+{% endif %}
+  * - :obj:`~{{ module }}.{{ obj }}`
+
+    - .. div:: sk-apisearch-desc
+
+        .. currentmodule:: {{ full_module }}
+
+        .. autoshortsummary:: {{ module }}.{{ obj }}
+
+        .. div:: caption
+
+          :mod:`{{ full_module }}`
+{% endfor %}
+{% endfor %}
+{% endfor %}
+
+{% for ver, objs in DEPRECATED_API_REFERENCE %}
+{% for obj in objs %}
+{% set parts = obj.rsplit(".", 1) %}
+{% if parts|length > 1 %}
+{% set full_module = "sklearn." + parts[0] %}
+{% else %}
+{% set full_module = "sklearn" %}
+{% endif %}
+  * - :obj:`~sklearn.{{ obj }}`
+
+    - .. div:: sk-apisearch-desc
+
+        .. currentmodule:: {{ full_module }}
+
+        .. autoshortsummary:: sklearn.{{ obj }}
+
+        .. div:: caption
+
+          :mod:`{{ full_module }}`
+          :bdg-ref-danger-line:`Deprecated in version {{ ver }} <api_depr_ref-{{ ver|replace(".", "-") }}>`
+{% endfor %}
+{% endfor %}
diff --git a/doc/api/module.rst.template b/doc/api/module.rst.template
@@ -0,0 +1,46 @@
+:html_theme.sidebar_secondary.remove:
+
+{%- if module == "sklearn" -%}
+{%- set module_hook = "sklearn" -%}
+{%- elif module.startswith("sklearn.") -%}
+{%- set module_hook = module[8:] -%}
+{%- else -%}
+{%- set module_hook = None -%}
+{%- endif -%}
+
+{% if module_hook %}
+.. _{{ module_hook }}_ref:
+{% endif %}
+
+{{ module }}
+{{ "=" * module|length }}
+
+.. automodule:: {{ module }}
+
+{% if module_info["description"] %}
+{{ module_info["description"] }}
+{% endif %}
+
+{% for section in module_info["sections"] %}
+{% if section["title"] and module_hook %}
+.. _{{ module_hook }}_ref-{{ section["title"]|lower|replace(" ", "-") }}:
+{% endif %}
+
+{% if section["title"] %}
+{{ section["title"] }}
+{{ "-" * section["title"]|length }}
+{% endif %}
+
+{% if section["description"] %}
+{{ section["description"] }}
+{% endif %}
+
+.. autosummary::
+  :nosignatures:
+  :toctree: ../modules/generated/
+  :template: base.rst
+
+{% for obj in section["autosummary"] %}
+  {{ obj }}
+{%- endfor %}
+{% endfor %}