diff --git a/doc/templates/class.rst b/doc/templates/class.rst index 79ff2cf807794..1e98be4099b73 100644 --- 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 index f98b7dbbf6578..bc1567709c9d3 100644 --- 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 index 857e2c28ce1da..5c31936f6fc36 100644 --- 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 index a04efcb80be07..072a31112be50 100644 --- 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 index c019992493610..a26afbead5451 100644 --- 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 index 6d13ac6aca2de..ead5abec27076 100644 --- 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 index 1211296bb57ce..b179473cf841e 100644 --- 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 index 6d064133fc5e2..9981910dc8be7 100644 --- 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 index f4b11eda770e4..93d368ecfe6d5 100644 --- 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 }}====================