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 5/8] Makefile: use splithtml tag for html target
Date: Wed, 28 Oct 2026 09:04:57 +0100	[thread overview]
Message-ID: <20261028-tags-v1-5-d5ad01019eae@bootlin.com> (raw)
In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com>

Sphinx has the ability to include content based on tags in the
documentation with the '.. only::' directive. As '.. only:: html' is
common to _all_ HTML-based documents (html, singlehtml, epub), there was
no way to differentiate the split HTML build from the others.

For that reason, add the splithtml tag when building it. The goal is be
able to to include content _only_ for this build type.

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

diff --git a/documentation/Makefile b/documentation/Makefile
index f165e36c2..2f2d6213d 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -55,6 +55,10 @@ latexpdf:
 
 all: html epub latexpdf
 
+html:
+	$(SOURCEDIR)/set_versions.py
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" --tag splithtml $(SPHINXOPTS)
+
 %:
 	$(SOURCEDIR)/set_versions.py
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

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