From: Quentin Schulz <foss+yocto@0leil.net>
To: Quentin Schulz <quentin.schulz@cherry.de>, docs@lists.yoctoproject.org
Subject: [PATCH RFC 0/2] add script for containers building the documentation
Date: Tue, 10 Dec 2024 16:26:43 +0100 [thread overview]
Message-ID: <20241210-instructions-shell-container-v1-0-6a7cdc404ff4@cherry.de> (raw)
Based on initial work done by Antonin Godard[1].
This does two things:
- move all the installation steps to fulfil the system requirements for
each distro into separate files,
- add a script for using those separate files for building a container
which allows to build the documentation within,
Note that Ubuntu (at least 24.04) and openSUSE instructions do not work
right now. Ubuntu has an issue with locales which are already reported
and fixes sent to the ML[2] (I have not tested the possible fix).
openSUSE seems to be running the sphinx build from a 3.6 Python
interpreter which has an incompatible API with the Python calls used in
Sphinx for our documentation.
[1] https://lore.kernel.org/yocto-docs/20241205-docs-build-dockerfiles-v2-1-047cb3245adf@bootlin.com/
[2] https://lore.kernel.org/yocto-docs/20241202110128.27711-1-guenael.muller@smile.fr/
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (2):
docs: use literalinclude for system requirements
tools: add script for building documentation inside containers
documentation/poky.yaml.in | 26 ------
documentation/ref-manual/system-requirements.rst | 45 ++++-----
documentation/tools/Containerfile.almalinux | 1 +
documentation/tools/Containerfile.apt | 21 +++++
documentation/tools/Containerfile.debian | 1 +
documentation/tools/Containerfile.dnf | 19 ++++
documentation/tools/Containerfile.fedora | 1 +
documentation/tools/Containerfile.ubuntu | 1 +
documentation/tools/Containerfile.zypper | 18 ++++
.../tools/almalinux_host_packages_docs.sh | 2 +
.../tools/almalinux_host_packages_essential.sh | 5 +
documentation/tools/build-docs-container | 101 +++++++++++++++++++++
documentation/tools/fedora_host_packages_docs.sh | 2 +
.../tools/fedora_host_packages_essential.sh | 1 +
documentation/tools/opensuse_host_packages_docs.sh | 2 +
.../tools/opensuse_host_packages_essential.sh | 2 +
documentation/tools/ubuntu_host_packages_docs.sh | 2 +
.../tools/ubuntu_host_packages_essential.sh | 2 +
18 files changed, 205 insertions(+), 47 deletions(-)
---
base-commit: 5835cb574881d57785f099c768467177d077e867
change-id: 20241210-instructions-shell-container-c5a84c043a35
Best regards,
--
Quentin Schulz <quentin.schulz@cherry.de>
next reply other threads:[~2024-12-10 15:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-10 15:26 Quentin Schulz [this message]
2024-12-10 15:26 ` [PATCH RFC 1/2] docs: use literalinclude for system requirements Quentin Schulz
2024-12-17 10:31 ` [docs] " Antonin Godard
2024-12-17 12:58 ` Quentin Schulz
2024-12-17 13:10 ` Antonin Godard
2024-12-17 13:15 ` Quentin Schulz
2024-12-10 15:26 ` [PATCH RFC 2/2] tools: add script for building documentation inside containers Quentin Schulz
2024-12-17 10:31 ` [docs] " Antonin Godard
2024-12-17 13:50 ` Quentin Schulz
2024-12-18 8:22 ` 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=20241210-instructions-shell-container-v1-0-6a7cdc404ff4@cherry.de \
--to=foss+yocto@0leil.net \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@cherry.de \
/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