Yocto Project Documentation
 help / color / mirror / Atom feed
From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Antonin Godard <antonin.godard@bootlin.com>,
	 Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH 7/8] index.rst: link to the tags overview page for splithtml
Date: Wed, 28 Oct 2026 09:04:59 +0100	[thread overview]
Message-ID: <20261028-tags-v1-7-d5ad01019eae@bootlin.com> (raw)
In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com>

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 --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
 =================================
 

-- 
2.55.0


  parent reply	other threads:[~2026-10-28  8:05 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-28  8:04 [PATCH 0/8] Add support for documentation tags Antonin Godard
2026-10-28  8:04 ` [PATCH 1/8] Pipfile: update dependencies for sphinx-tags Antonin Godard
2026-10-28  8:04 ` [PATCH 2/8] tools/host_packages_scripts/pip3_docs.sh: update " Antonin Godard
2026-10-28  8:04 ` [PATCH 3/8] conf.py: enable the sphinx-tags extension Antonin Godard
2026-10-28  8:04 ` [PATCH 4/8] sphinx-static/theme_overrides.css: customize tags appearance Antonin Godard
2026-10-28  8:04 ` [PATCH 5/8] Makefile: use splithtml tag for html target Antonin Godard
2026-10-28  8:04 ` [PATCH 6/8] docs-wide: tag sections Antonin Godard
2026-10-28  8:04 ` Antonin Godard [this message]
2026-10-28  8:05 ` [PATCH 8/8] standards.md: add note about document tags Antonin Godard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261028-tags-v1-7-d5ad01019eae@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox