diff mbox series

index.rst: show the intro paragraph only for html-based docs

Message ID 20260818-intros-only-in-html-v1-1-4fe4c54655bf@bootlin.com
State Under Review
Headers show
Series index.rst: show the intro paragraph only for html-based docs | expand

Commit Message

Antonin Godard Aug. 18, 2026, 7:34 a.m. UTC 
The current non-HTML-based documents we support is the PDF format. For
this format, this intro paragraph is placed right after the table of
contents, which is odd and breaks the flow of the document. Show this
paragraph only in HTML-based document, which includes the HTML and ePUB
formats.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/index.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)


---
base-commit: 41dae3c3da3ada1745fc60228ff6269c64ee2361
change-id: 20260811-intros-only-in-html-424eabb734ca
diff mbox series

Patch

diff --git a/documentation/index.rst b/documentation/index.rst
index afabb6615..9fe4f6acf 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -9,10 +9,12 @@ 
 Welcome to the Yocto Project Documentation
 ==========================================
 
-This is the top level of the Yocto Project documentation tree. The Yocto Project
-documentation is always a work in progress, just like the Yocto Project itself.
-Improvements to the documentation are always welcome; join the
-:yocto_lists:`docs mailing list </g/docs>` if you want to help out.
+.. only:: html
+
+   This is the top level of the Yocto Project documentation tree. The Yocto
+   Project documentation is always a work in progress, just like the Yocto
+   Project itself. Improvements to the documentation are always welcome; join
+   the :yocto_lists:`docs mailing list </g/docs>` if you want to help out.
 
 Introduction and Overview
 =========================