48e5b5f994
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>
67 lines
1.8 KiB
Python
67 lines
1.8 KiB
Python
# coding=utf-8
|
|
#
|
|
# QEMU depfile generation extension
|
|
#
|
|
# Copyright (c) 2020 Red Hat, Inc.
|
|
#
|
|
# This work is licensed under the terms of the GNU GPLv2 or later.
|
|
# See the COPYING file in the top-level directory.
|
|
|
|
"""depfile is a Sphinx extension that writes a dependency file for
|
|
an external build system"""
|
|
|
|
import os
|
|
import sphinx
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
__version__ = '1.0'
|
|
|
|
def get_infiles(env):
|
|
for x in env.found_docs:
|
|
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():
|
|
if hasattr(mod, '__file__'):
|
|
if mod.__file__:
|
|
yield mod.__file__
|
|
# this is perhaps going to include unused files:
|
|
for static_path in env.config.html_static_path + env.config.templates_path:
|
|
for path in Path(static_path).rglob('*'):
|
|
yield str(path)
|
|
|
|
|
|
def write_depfile(app, exception):
|
|
if exception:
|
|
return
|
|
|
|
env = app.env
|
|
if not env.config.depfile:
|
|
return
|
|
|
|
# Using a directory as the output file does not work great because
|
|
# its timestamp does not necessarily change when the contents change.
|
|
# So create a timestamp file.
|
|
if env.config.depfile_stamp:
|
|
with open(env.config.depfile_stamp, 'w') as f:
|
|
pass
|
|
|
|
with open(env.config.depfile, 'w') as f:
|
|
print((env.config.depfile_stamp or app.outdir) + ": \\", file=f)
|
|
print(*get_infiles(env), file=f)
|
|
for x in get_infiles(env):
|
|
print(x + ":", file=f)
|
|
|
|
|
|
def setup(app):
|
|
app.add_config_value('depfile', None, 'env')
|
|
app.add_config_value('depfile_stamp', None, 'env')
|
|
app.connect('build-finished', write_depfile)
|
|
|
|
return dict(
|
|
version = __version__,
|
|
parallel_read_safe = True,
|
|
parallel_write_safe = True
|
|
)
|