Re: [PATCH v3] docs: scripts: sphinx-pre-install: Fix building docs with pyyaml package

From: Jonathan Corbet
Date: Wed Feb 14 2024 - 17:35:38 EST


Thorsten Blum <thorsten.blum@xxxxxxxxxx> writes:

> The Python module pyyaml is required to build the docs, but it is only
> listed in Documentation/sphinx/requirements.txt and is therefore missing
> when Sphinx is installed as a package and not via pip/pypi.
>
> Add pyyaml as an optional package for multiple distros to fix building the
> docs if you prefer to install Sphinx as a package.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@xxxxxxxxxx>
> Reviewed-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>
> Tested-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>
> ---
> Changes in v2:
> - s/pyyaml/yaml/ as suggested by Vegard Nossum
> - Make the check require the Python module; was optional
>
> Changes in v3:
> - Preserve Reviewed-by: and Tested-by: tags
> - Add pyyaml to openSUSE as suggested by Vegard Nossum
> ---
> scripts/sphinx-pre-install | 4 ++++
> 1 file changed, 4 insertions(+)

Applied, thanks.

jon