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 0/8] Add support for documentation tags
Date: Wed, 28 Oct 2026 09:04:52 +0100	[thread overview]
Message-ID: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> (raw)

This series aims at making discovering documentation easier for users.
The Yocto Project documentation is a long-lasting repository and
nowadays has *lots* of documentation:

❯ cat -p $(find . -name "*.rst" | grep -v migration-guides) | wc -l
61530

Looking for documentation has always been a trouble of mine, so this
series adds support for tags. Tags are keywords that show at the bottom
of pages and that group different sections of the documentation by a
common category.

For example, all sstate related pages are grouped under the 'sstate'
tag. Users wanting to learn about its concept or how to use it can know
where to go from the 'sstate' tag page.

A tag overview page is also create and lists all known documentation tags.

A series will be sent to OE-Core to add sphinx-tags to the buildtools
tarball used on the Autobuilder for the docs build.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (8):
      Pipfile: update dependencies for sphinx-tags
      tools/host_packages_scripts/pip3_docs.sh: update for sphinx-tags
      conf.py: enable the sphinx-tags extension
      sphinx-static/theme_overrides.css: customize tags appearance
      Makefile: use splithtml tag for html target
      docs-wide: tag sections
      index.rst: link to the tags overview page for splithtml
      standards.md: add note about document tags

 documentation/.gitignore                           |  1 +
 documentation/Makefile                             |  6 +++++-
 documentation/Pipfile                              |  2 ++
 documentation/conf.py                              |  8 ++++++++
 .../contributor-guide/identify-component.rst       |  4 ++++
 .../contributor-guide/recipe-style-guide.rst       |  4 ++++
 documentation/contributor-guide/report-defect.rst  |  4 ++++
 documentation/contributor-guide/submit-changes.rst |  4 ++++
 documentation/conventions.rst                      |  4 ++++
 documentation/dev-manual/bblock.rst                |  3 +++
 documentation/dev-manual/bmaptool.rst              |  4 ++++
 documentation/dev-manual/build-quality.rst         |  3 +++
 documentation/dev-manual/building.rst              |  3 +++
 documentation/dev-manual/creating-fragments.rst    |  4 ++++
 documentation/dev-manual/custom-distribution.rst   |  4 ++++
 .../custom-template-configuration-directory.rst    |  3 +++
 documentation/dev-manual/customizing-images.rst    |  3 +++
 documentation/dev-manual/debugging.rst             |  3 +++
 documentation/dev-manual/development-shell.rst     |  3 +++
 documentation/dev-manual/device-manager.rst        |  3 +++
 documentation/dev-manual/devtool.rst               |  4 ++++
 documentation/dev-manual/disk-space.rst            |  4 ++++
 .../dev-manual/efficiently-fetching-sources.rst    |  3 +++
 documentation/dev-manual/error-reporting-tool.rst  |  3 +++
 documentation/dev-manual/external-scm.rst          |  3 +++
 documentation/dev-manual/external-toolchain.rst    |  4 ++++
 documentation/dev-manual/gobject-introspection.rst |  3 +++
 documentation/dev-manual/hashequivserver.rst       |  4 ++++
 documentation/dev-manual/init-manager.rst          |  4 ++++
 documentation/dev-manual/layers.rst                |  3 +++
 documentation/dev-manual/libraries.rst             |  3 +++
 documentation/dev-manual/licenses.rst              |  3 +++
 documentation/dev-manual/limiting-resources.rst    |  4 ++++
 documentation/dev-manual/multiconfig.rst           |  4 ++++
 documentation/dev-manual/new-machine.rst           |  3 +++
 documentation/dev-manual/new-recipe.rst            |  3 +++
 documentation/dev-manual/packages.rst              |  3 +++
 documentation/dev-manual/poky-manual-setup.rst     |  4 ++++
 documentation/dev-manual/prebuilt-libraries.rst    |  3 +++
 .../dev-manual/python-development-shell.rst        |  3 +++
 documentation/dev-manual/qemu.rst                  |  4 ++++
 documentation/dev-manual/quilt.rst                 |  3 +++
 documentation/dev-manual/sbom.rst                  |  4 ++++
 documentation/dev-manual/speeding-up-build.rst     |  3 +++
 documentation/dev-manual/sstate-mirrors-setup.rst  |  4 ++++
 documentation/dev-manual/start.rst                 |  4 ++++
 documentation/dev-manual/temporary-source-code.rst |  4 ++++
 documentation/dev-manual/upgrading-recipes.rst     |  3 +++
 documentation/dev-manual/wayland.rst               |  3 +++
 documentation/dev-manual/wic.rst                   |  3 +++
 documentation/dev-manual/x32-psabi.rst             |  3 +++
 documentation/index.rst                            | 11 +++++++++++
 documentation/kernel-dev/index.rst                 |  4 ++++
 documentation/overview-manual/concepts.rst         |  4 ++++
 .../overview-manual/development-environment.rst    |  4 ++++
 documentation/overview-manual/yp-intro.rst         |  4 ++++
 documentation/profile-manual/index.rst             |  4 ++++
 documentation/ref-manual/devtool-reference.rst     |  4 ++++
 documentation/ref-manual/fragments.rst             |  4 ++++
 documentation/ref-manual/kickstart.rst             |  4 ++++
 documentation/ref-manual/release-process.rst       |  4 ++++
 documentation/sdk-manual/index.rst                 |  4 ++++
 .../security-manual/build-process-security.rst     |  4 ++++
 documentation/security-manual/read-only-rootfs.rst |  3 +++
 documentation/security-manual/securing-images.rst  |  3 +++
 documentation/security-manual/sstate-signing.rst   |  4 ++++
 documentation/security-manual/vulnerabilities.rst  |  3 +++
 documentation/security-reference/index.rst         |  4 ++++
 documentation/sphinx-static/theme_overrides.css    | 23 ++++++++++++++++++++++
 documentation/standards.md                         | 15 ++++++++++++++
 documentation/test-manual/ptest.rst                |  4 ++++
 documentation/test-manual/reproducible-builds.rst  |  4 ++++
 documentation/test-manual/runtime-testing.rst      |  3 +++
 documentation/test-manual/test-process.rst         |  4 ++++
 documentation/toaster-manual/index.rst             |  4 ++++
 .../tools/host_packages_scripts/pip3_docs.sh       |  2 +-
 76 files changed, 308 insertions(+), 2 deletions(-)
---
base-commit: 7b54854d12f3f2c909727702d39066a3d22a4a40
change-id: 20261021-tags-3b858a172be2


             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 Antonin Godard [this message]
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 ` [PATCH 7/8] index.rst: link to the tags overview page for splithtml Antonin Godard
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-0-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