FIX workaround sphinx limitation with rst_prolog (scikit-learn#26680)

glemaitre · web-flow · commit 50f17a338290 · 2023-06-23T12:03:21.000+02:00
diff --git a/doc/templates/class.rst b/doc/templates/class.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}==============
 
diff --git a/doc/templates/class_with_call.rst b/doc/templates/class_with_call.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}===============
 
diff --git a/doc/templates/deprecated_class.rst b/doc/templates/deprecated_class.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}==============
 
diff --git a/doc/templates/deprecated_class_with_call.rst b/doc/templates/deprecated_class_with_call.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}===============
 
diff --git a/doc/templates/deprecated_class_without_init.rst b/doc/templates/deprecated_class_without_init.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}==============
 
diff --git a/doc/templates/deprecated_function.rst b/doc/templates/deprecated_function.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}====================
 
diff --git a/doc/templates/display_all_class_methods.rst b/doc/templates/display_all_class_methods.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}==============
 
diff --git a/doc/templates/display_only_from_estimator.rst b/doc/templates/display_only_from_estimator.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}==============
 
diff --git a/doc/templates/function.rst b/doc/templates/function.rst
@@ -1,3 +1,8 @@
+..
+    The empty line below should not be removed. It is added such that the `rst_prolog`
+    is added before the :mod: directive. Otherwise, the rendering will show as a
+    paragraph instead of a header.
+
 :mod:`{{module}}`.{{objname}}
 {{ underline }}====================
 
