github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-06-04 04:23:35 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

tools/docs: sphinx-build-wrapper: add support to run inside venv

Browse Source 
Sometimes, it is desired to run Sphinx from a virtual environment.
Add a command line parameter to automatically build Sphinx from
such environment.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-ID: <e34fa63a61e75a0ec86b37c9b5fafa6677f44c6c.1758196090.git.mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2025-09-18 13:54:58 +02:00 committed by Jonathan Corbet
parent 62ea383b44
commit 42180ada39
1 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
tools/docs/sphinx-build-wrapper
View File

@ -69,6 +69,7 @@ from jobserver import JobserverExec # pylint: disable=C0413,C0411,E0401
#
# Some constants
#
VENV_DEFAULT = "sphinx_latest"
MIN_PYTHON_VERSION = PythonVersion("3.7").version
PAPER = ["", "a4", "letter"]
@ -171,8 +172,10 @@ class SphinxBuilder:
if not verbose:
self.sphinxopts += ["-q"]
def __init__(self, builddir, verbose=False, n_jobs=None, interactive=None):
def __init__(self, builddir, venv=None, verbose=False, n_jobs=None,
interactive=None):
"""Initialize internal variables"""
self.venv = venv
self.verbose = None
#
@ -220,6 +223,21 @@ class SphinxBuilder:
self.get_sphinx_extra_opts(n_jobs)
#
# If venv command line argument is specified, run Sphinx from venv
#
if venv:
bin_dir = os.path.join(venv, "bin")
if not os.path.isfile(os.path.join(bin_dir, "activate")):
sys.exit(f"Venv {venv} not found.")
# "activate" virtual env
self.env["PATH"] = bin_dir + ":" + self.env["PATH"]
self.env["VIRTUAL_ENV"] = venv
if "PYTHONHOME" in self.env:
del self.env["PYTHONHOME"]
print(f"Setting venv to {venv}")
def run_sphinx(self, sphinx_build, build_args, *args, **pwargs):
"""
Executes sphinx-build using current python3 command.
@ -254,7 +272,12 @@ class SphinxBuilder:
if self.n_jobs:
n_jobs = str(self.n_jobs)
cmd = [sys.executable, sphinx_build]
if self.venv:
cmd = ["python"]
else:
cmd = [sys.executable,]
cmd += [sphinx_build]
cmd += [f"-j{n_jobs}"]
cmd += self.sphinxopts
cmd += build_args
@ -772,12 +795,16 @@ def main():
parser.add_argument('-i', '--interactive', action='store_true',
help="Change latex default to run in interactive mode")
parser.add_argument("-V", "--venv", nargs='?', const=f'{VENV_DEFAULT}',
default=None,
help=f'If used, run Sphinx from a venv dir (default dir: {VENV_DEFAULT})')
args = parser.parse_args()
PythonVersion.check_python(MIN_PYTHON_VERSION, show_alternatives=True,
bail_out=True)
builder = SphinxBuilder(builddir=args.builddir,
builder = SphinxBuilder(builddir=args.builddir, venv=args.venv,
verbose=args.verbose, n_jobs=args.jobs,
interactive=args.interactive)