summary refs log tree commit diff stats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2025-08-14 18:13:21 +0100
committerPeter Maydell <peter.maydell@linaro.org>2025-08-30 16:37:23 +0100
commit33be8171e2fe02173d24ffd61bd97bf9c2b37834 (patch)
tree2e89165ee65fc8bf63b76641557470d2c6939a1b /docs/conf.py
parent9cbe72b868b7cb04f7553220738f1286b6f0dc32 (diff)
downloadfocaccia-qemu-33be8171e2fe02173d24ffd61bd97bf9c2b37834.tar.gz
focaccia-qemu-33be8171e2fe02173d24ffd61bd97bf9c2b37834.zip
scripts/kerneldoc: Switch to the Python kernel-doc script
Change the Sphinx config to run the new Python kernel-doc script
instead of the Perl one.  The only difference between the two is that
the new script does not handle the -sphinx-version option, instead
assuming that Sphinx is always at least version 3: so we must
delete the code that passes that option to avoid the Python
script complaining about an unknown option.

QEMU's minimum Sphinx version is already 3.4.3, so this doesn't
change the set of versions we can handle.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-id: 20250814171324.1614516-7-peter.maydell@linaro.org
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index f892a6e1da..e09769e5f8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -341,7 +341,9 @@ man_make_section_directory = False
 # We use paths starting from qemu_docdir here so that you can run
 # sphinx-build from anywhere and the kerneldoc extension can still
 # find everything.
-kerneldoc_bin = ['perl', os.path.join(qemu_docdir, '../scripts/kernel-doc')]
+# Since kernel-doc is now a Python script, we should run it with whatever
+# Python this sphinx is using (rather than letting it find one via env)
+kerneldoc_bin = [sys.executable, os.path.join(qemu_docdir, '../scripts/kernel-doc.py')]
 kerneldoc_srctree = os.path.join(qemu_docdir, '..')
 hxtool_srctree = os.path.join(qemu_docdir, '..')
 qapidoc_srctree = os.path.join(qemu_docdir, '..')