mbox series

[RFC,0/2] add script for containers building the documentation

Message ID 20241210-instructions-shell-container-v1-0-6a7cdc404ff4@cherry.de
Headers show
Series add script for containers building the documentation | expand

Message

Quentin Schulz Dec. 10, 2024, 3:26 p.m. UTC
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,