aboutsummaryrefslogtreecommitdiff
path: root/docs/sphinx/depfile.py
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2024-07-29 13:05:33 +0100
committerPhilippe Mathieu-Daudé <philmd@linaro.org>2024-07-31 00:13:59 +0200
commit48e5b5f994bccf161dd88a67fdd819d4bfb400f1 (patch)
tree9d363f39000ac6a3a27b1df4665851fe7062d198 /docs/sphinx/depfile.py
parentd4181658dfb66b89e304077e89d8d173b1201ff6 (diff)
downloadqemu-48e5b5f994bccf161dd88a67fdd819d4bfb400f1.zip
qemu-48e5b5f994bccf161dd88a67fdd819d4bfb400f1.tar.gz
qemu-48e5b5f994bccf161dd88a67fdd819d4bfb400f1.tar.bz2
docs/sphinx/depfile.py: Handle env.doc2path() returning a Path not a str
In newer versions of Sphinx the env.doc2path() API is going to change to return a Path object rather than a str. This was originally visible in Sphinx 8.0.0rc1, but has been rolled back for the final 8.0.0 release. However it will probably emit a deprecation warning and is likely to change for good in 9.0: https://github.com/sphinx-doc/sphinx/issues/12686 Our use in depfile.py assumes a str, and if it is passed a Path it will fall over: Handler <function write_depfile at 0x77a1775ff560> for event 'build-finished' threw an exception (exception: unsupported operand type(s) for +: 'PosixPath' and 'str') Wrapping the env.doc2path() call in str() will coerce a Path object to the str we expect, and have no effect in older Sphinx versions that do return a str. Cc: qemu-stable@nongnu.org Resolves: https://gitlab.com/qemu-project/qemu/-/issues/2458 Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> Message-ID: <20240729120533.2486427-1-peter.maydell@linaro.org> Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Diffstat (limited to 'docs/sphinx/depfile.py')
-rw-r--r--docs/sphinx/depfile.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py
index afdcbce..e74be6a 100644
--- a/docs/sphinx/depfile.py
+++ b/docs/sphinx/depfile.py
@@ -19,7 +19,7 @@ __version__ = '1.0'
def get_infiles(env):
for x in env.found_docs:
- yield env.doc2path(x)
+ yield str(env.doc2path(x))
yield from ((os.path.join(env.srcdir, dep)
for dep in env.dependencies[x]))
for mod in sys.modules.values():