nagai/kernel
3
0
Fork 0
forked from mirrors/linux
Code Pull requests Activity

docs: scripts: sphinx-pre-install: Fix building docs with pyyaml package

Browse source 
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@toblux.com>
Reviewed-by: Vegard Nossum <vegard.nossum@oracle.com>
Tested-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240208205550.984-1-thorsten.blum@toblux.com
This commit is contained in:
Thorsten Blum 2024-02-08 21:55:51 +01:00 committed by Jonathan Corbet
parent dc8769a882
commit 84b4cc8189
1 changed files with 4 additions and 0 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

4
scripts/sphinx-pre-install
View file

@ -361,6 +361,7 @@ sub give_debian_hints()
{ {
my %map = ( my %map = (
"python-sphinx" => "python3-sphinx", "python-sphinx" => "python3-sphinx",
"yaml" => "python3-yaml",
"ensurepip" => "python3-venv", "ensurepip" => "python3-venv",
"virtualenv" => "virtualenv", "virtualenv" => "virtualenv",
"dot" => "graphviz", "dot" => "graphviz",
@ -395,6 +396,7 @@ sub give_redhat_hints()
{ {
my %map = ( my %map = (
"python-sphinx" => "python3-sphinx", "python-sphinx" => "python3-sphinx",
"yaml" => "python3-pyyaml",
"virtualenv" => "python3-virtualenv", "virtualenv" => "python3-virtualenv",
"dot" => "graphviz", "dot" => "graphviz",
"convert" => "ImageMagick", "convert" => "ImageMagick",
@ -477,6 +479,7 @@ sub give_opensuse_hints()
{ {
my %map = ( my %map = (
"python-sphinx" => "python3-sphinx", "python-sphinx" => "python3-sphinx",
"yaml" => "python3-pyyaml",
"virtualenv" => "python3-virtualenv", "virtualenv" => "python3-virtualenv",
"dot" => "graphviz", "dot" => "graphviz",
"convert" => "ImageMagick", "convert" => "ImageMagick",
@ -956,6 +959,7 @@ sub check_needs()
# Check for needed programs/tools # Check for needed programs/tools
check_perl_module("Pod::Usage", 0); check_perl_module("Pod::Usage", 0);
check_python_module("yaml", 0);
check_program("make", 0); check_program("make", 0);
check_program("gcc", 0); check_program("gcc", 0);
check_program("dot", 1); check_program("dot", 1);