diff mbox series

[7/8] index.rst: link to the tags overview page for splithtml

Message ID 20261028-tags-v1-7-d5ad01019eae@bootlin.com
State New
Headers show
Series Add support for documentation tags | expand

Commit Message

Antonin Godard Oct. 28, 2026, 8:04 a.m. UTC
The sphinx-tag extension only works for the splithtml build type.
However, adding a toctree entry with the '.. only::' directive is not
possible with Sphinx (see the warning admonition in [1]).

For that reason, only add a sentence that references this tag overview
page.

[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/index.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
diff mbox series

Patch

diff --git a/documentation/index.rst b/documentation/index.rst
index 72e51a445..a150ab605 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -41,6 +41,17 @@  Additional introductory resources.
 -  `Technical Overview (external website) <https://www.yoctoproject.org/development/technical-overview/>`__
 -  `Tips and Tricks Wiki (external website) <https://wiki.yoctoproject.org/wiki/TipsAndTricks>`__
 
+..
+   The conditional note below cannot hold a toctree directive properly: the
+   toctree addition would appear in all documentation types (singlehtml, pdf,
+   ...). Use a bare sentence instead as tags are only supported in the "html"
+   sphinx build mode.
+
+.. only:: splithtml
+
+   Sections of this documentation are also grouped by categories with tags. An
+   overview is available at the following page: :ref:`tagoverview`.
+
 Contributing to the Yocto Project
 =================================