From 019f9be81b90ca7848964e3d955cfcdb3f423a5c Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Fri, 23 Jun 2023 10:55:46 +0200 Subject: [PATCH 1/4] FIX workaround sphinx limitation with rst_prolog --- doc/templates/class.rst | 1 + doc/templates/class_with_call.rst | 1 + doc/templates/deprecated_class.rst | 1 + doc/templates/deprecated_class_with_call.rst | 1 + doc/templates/deprecated_class_without_init.rst | 1 + doc/templates/deprecated_function.rst | 1 + doc/templates/display_all_class_methods.rst | 1 + doc/templates/display_only_from_estimator.rst | 1 + doc/templates/function.rst | 1 + 9 files changed, 9 insertions(+) diff --git a/doc/templates/class.rst b/doc/templates/class.rst index 79ff2cf807794..d17c7f146ecce 100644 --- a/doc/templates/class.rst +++ b/doc/templates/class.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}============== diff --git a/doc/templates/class_with_call.rst b/doc/templates/class_with_call.rst index f98b7dbbf6578..0f85534426cef 100644 --- a/doc/templates/class_with_call.rst +++ b/doc/templates/class_with_call.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}=============== diff --git a/doc/templates/deprecated_class.rst b/doc/templates/deprecated_class.rst index 857e2c28ce1da..9671c3da2746e 100644 --- a/doc/templates/deprecated_class.rst +++ b/doc/templates/deprecated_class.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}============== diff --git a/doc/templates/deprecated_class_with_call.rst b/doc/templates/deprecated_class_with_call.rst index a04efcb80be07..a0eef69213f30 100644 --- a/doc/templates/deprecated_class_with_call.rst +++ b/doc/templates/deprecated_class_with_call.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}=============== diff --git a/doc/templates/deprecated_class_without_init.rst b/doc/templates/deprecated_class_without_init.rst index c019992493610..65e6e7c33ba77 100644 --- a/doc/templates/deprecated_class_without_init.rst +++ b/doc/templates/deprecated_class_without_init.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}============== diff --git a/doc/templates/deprecated_function.rst b/doc/templates/deprecated_function.rst index 6d13ac6aca2de..469c095a6fe45 100644 --- a/doc/templates/deprecated_function.rst +++ b/doc/templates/deprecated_function.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}==================== diff --git a/doc/templates/display_all_class_methods.rst b/doc/templates/display_all_class_methods.rst index 1211296bb57ce..2f203c1f8dd32 100644 --- a/doc/templates/display_all_class_methods.rst +++ b/doc/templates/display_all_class_methods.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}============== diff --git a/doc/templates/display_only_from_estimator.rst b/doc/templates/display_only_from_estimator.rst index 6d064133fc5e2..ec35c96ba1f40 100644 --- a/doc/templates/display_only_from_estimator.rst +++ b/doc/templates/display_only_from_estimator.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}============== diff --git a/doc/templates/function.rst b/doc/templates/function.rst index f4b11eda770e4..cf38a6cde7bf0 100644 --- a/doc/templates/function.rst +++ b/doc/templates/function.rst @@ -1,3 +1,4 @@ + :mod:`{{module}}`.{{objname}} {{ underline }}==================== From 524d7a5e0190ba94f193a616e80f3d04c9ba6cbe Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Fri, 23 Jun 2023 10:56:12 +0200 Subject: [PATCH 2/4] [doc build] generate doc From 86adb79e3ba793cb7995a0ca2dd335d9c6918780 Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Fri, 23 Jun 2023 11:10:13 +0200 Subject: [PATCH 3/4] [doc build] explicit comment for empty line --- doc/templates/class.rst | 4 ++++ doc/templates/class_with_call.rst | 4 ++++ doc/templates/deprecated_class.rst | 4 ++++ doc/templates/deprecated_class_with_call.rst | 4 ++++ doc/templates/deprecated_class_without_init.rst | 4 ++++ doc/templates/deprecated_function.rst | 4 ++++ doc/templates/display_all_class_methods.rst | 4 ++++ 7 files changed, 28 insertions(+) diff --git a/doc/templates/class.rst b/doc/templates/class.rst index d17c7f146ecce..1e98be4099b73 100644 --- a/doc/templates/class.rst +++ b/doc/templates/class.rst @@ -1,3 +1,7 @@ +.. + 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 0f85534426cef..bc1567709c9d3 100644 --- a/doc/templates/class_with_call.rst +++ b/doc/templates/class_with_call.rst @@ -1,3 +1,7 @@ +.. + 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 9671c3da2746e..5c31936f6fc36 100644 --- a/doc/templates/deprecated_class.rst +++ b/doc/templates/deprecated_class.rst @@ -1,3 +1,7 @@ +.. + 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 a0eef69213f30..072a31112be50 100644 --- a/doc/templates/deprecated_class_with_call.rst +++ b/doc/templates/deprecated_class_with_call.rst @@ -1,3 +1,7 @@ +.. + 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 65e6e7c33ba77..a26afbead5451 100644 --- a/doc/templates/deprecated_class_without_init.rst +++ b/doc/templates/deprecated_class_without_init.rst @@ -1,3 +1,7 @@ +.. + 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 469c095a6fe45..ead5abec27076 100644 --- a/doc/templates/deprecated_function.rst +++ b/doc/templates/deprecated_function.rst @@ -1,3 +1,7 @@ +.. + 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 2f203c1f8dd32..b179473cf841e 100644 --- a/doc/templates/display_all_class_methods.rst +++ b/doc/templates/display_all_class_methods.rst @@ -1,3 +1,7 @@ +.. + 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 }}============== From 5fc0354543b55e5b18a5522ff020367f68faeddb Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Fri, 23 Jun 2023 11:14:48 +0200 Subject: [PATCH 4/4] [doc build] explicit comment for empty line --- doc/templates/display_only_from_estimator.rst | 4 ++++ doc/templates/function.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/templates/display_only_from_estimator.rst b/doc/templates/display_only_from_estimator.rst index ec35c96ba1f40..9981910dc8be7 100644 --- a/doc/templates/display_only_from_estimator.rst +++ b/doc/templates/display_only_from_estimator.rst @@ -1,3 +1,7 @@ +.. + 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 cf38a6cde7bf0..93d368ecfe6d5 100644 --- a/doc/templates/function.rst +++ b/doc/templates/function.rst @@ -1,3 +1,7 @@ +.. + 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 }}====================