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 3/8] conf.py: enable the sphinx-tags extension
Date: Wed, 28 Oct 2026 09:04:55 +0100	[thread overview]
Message-ID: <20261028-tags-v1-3-d5ad01019eae@bootlin.com> (raw)
In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com>

The sphinx-tags extension can be used to add tags to document, which
then creates a section of the documentation with a list of tags which
group documents. This should help users finding the different documents
across the Yocto Project documentation which fall under a common
category.

Update the Makefile to remove the generated _tags/ directory on a make
clean, and the .gitignore.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/.gitignore | 1 +
 documentation/Makefile   | 2 +-
 documentation/conf.py    | 8 ++++++++
 3 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/documentation/.gitignore b/documentation/.gitignore
index d6d020efb..84d82f45d 100644
--- a/documentation/.gitignore
+++ b/documentation/.gitignore
@@ -1,5 +1,6 @@
 sphinx/__pycache__
 _build/
+_tags/
 Pipfile.lock
 poky.yaml
 sphinx-static/switchers.js
diff --git a/documentation/Makefile b/documentation/Makefile
index 2df23ebf4..f165e36c2 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -33,7 +33,7 @@ publish: Makefile checks epub latexpdf html singlehtml
 	sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html
 
 clean:
-	@rm -rf $(BUILDDIR) poky.yaml sphinx-static/switchers.js releases.rst releases.json
+	@rm -rf $(BUILDDIR) _tags/ poky.yaml sphinx-static/switchers.js releases.rst releases.json
 
 checks:
 	$(SOURCEDIR)/tools/check-glossaries --docs-dir $(SOURCEDIR)
diff --git a/documentation/conf.py b/documentation/conf.py
index d2252d5ab..75d062945 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -50,6 +50,7 @@ extensions = [
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx_copybutton',
+    'sphinx_tags',
     'sphinxcontrib.rsvgconverter',
     'yocto-vars'
 ]
@@ -260,3 +261,10 @@ copybutton_prompt_is_regexp = True
 copybutton_only_copy_prompt_lines = True
 copybutton_remove_prompts = True
 copybutton_line_continuation_character = "\\"
+
+# -- sphinx_tags configuration -----------------------------------------------
+
+tags_create_tags = True
+tags_page_title = "Tag"
+tags_page_header = "Document(s) with this tag"
+tags_create_badges = True

-- 
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 ` Antonin Godard [this message]
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-3-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