From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1851) id 0916B3858290; Tue, 8 Nov 2022 11:43:47 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 0916B3858290 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1667907827; bh=vleof5pE/Fo5LIXpu3jC/qKul24UX9MHgRc6ruqDYdo=; h=From:To:Subject:Date:From; b=FlkeuBQdF/s5K17k/0o1U/8sGyikHwugMSFcvaqFUookf6GdfUEQ5RWmlMfJqbqW4 AfZ9gRi6ZLiyyqByoIoAxlg91mrNfvL5e9iCCcc/FTe8GNshLWr1+3410QhsvASkeL E8KDqYTI6p0Z3nlHeoYJ2n6QF0Kv0PTSgRikr7HU= Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: Martin Liska To: gcc-cvs@gcc.gnu.org Subject: [gcc(refs/users/marxin/heads/sphinx-final)] FIXME: sphinx: add update_web_docs_git.py script X-Act-Checkin: gcc X-Git-Author: Martin Liska X-Git-Refname: refs/users/marxin/heads/sphinx-final X-Git-Oldrev: c034263cb0ae05c0cc27dceef726a60f28a59590 X-Git-Newrev: 36d48c3ba08f5a6d21ac53b8bd6aee7816c5787a Message-Id: <20221108114347.0916B3858290@sourceware.org> Date: Tue, 8 Nov 2022 11:43:47 +0000 (GMT) List-Id: https://gcc.gnu.org/g:36d48c3ba08f5a6d21ac53b8bd6aee7816c5787a commit 36d48c3ba08f5a6d21ac53b8bd6aee7816c5787a Author: Martin Liska Date: Mon Nov 7 22:07:47 2022 +0100 FIXME: sphinx: add update_web_docs_git.py script maintainer-scripts/ChangeLog: * update_web_docs_git.py: New file. Diff: --- maintainer-scripts/update_web_docs_git.py | 81 +++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/maintainer-scripts/update_web_docs_git.py b/maintainer-scripts/update_web_docs_git.py new file mode 100755 index 00000000000..a02d0d1e6b0 --- /dev/null +++ b/maintainer-scripts/update_web_docs_git.py @@ -0,0 +1,81 @@ +#!/usr/bin/env python3 + +# Generate documentation from Sphinx files. + +import argparse +import os +import shutil +import subprocess +import tempfile +from pathlib import Path + +GITROOT = '/git/gcc.git' +BUGURL = 'https://gcc.gnu.org/bugs/' + +parser = argparse.ArgumentParser(description='Update web documentation.') +parser.add_argument('output_folder', help='Output folder') +parser.add_argument('--gitrepo', help=f'Git repository (default: {GITROOT})', + default=GITROOT) +parser.add_argument('--sphinx-build', help='Path to sphinx-build binary') +args = parser.parse_args() + + +def find_configs(): + for root, _, files in os.walk('.'): + for f in files: + full = os.path.join(root, f) + if f == 'conf.py': + # find name of the documentation + lines = open(full).read().splitlines() + docname = None + for line in lines: + if line.startswith('name = '): + docname = line.split()[-1].strip("'") + break + assert docname + yield (Path(root).resolve(), docname) + + +with tempfile.TemporaryDirectory() as folder: + print(f'Using {folder} as temporary directory') + os.chdir(folder) + subprocess.check_output(f'git clone {args.gitrepo} --depth=1', shell=True) + # TODO: remove + os.chdir('gcc') + cmd = 'git fetch origin refs/users/marxin/heads/sphinx-final --depth=1' + subprocess.check_output(cmd, shell=True) + subprocess.check_output('git checkout FETCH_HEAD', shell=True) + configs = list(find_configs()) + + # Prepare folders + output = Path(args.output_folder) + if not output.exists(): + output.mkdir() + + temp = Path('tmp').resolve() + temp.mkdir() + + # Prepare default env. variables + childenv = os.environ.copy() + childenv['BUGURL'] = BUGURL + + # Build and copy the documentation + for config_folder, docname in sorted(configs): + print('=== BUILDING:', config_folder, docname, '===') + + # Build HTML + cmd = f'make -C doc html SOURCEDIR={config_folder} BUILDDIR={temp}/{docname}' + if args.sphinx_build: + cmd += f' SPHINXBUILD={args.sphinx_build}' + subprocess.check_output(cmd, shell=True, env=childenv) + os.unlink(f'{temp}/{docname}/html/.buildinfo') + shutil.copytree(f'{temp}/{docname}/html', f'{output}/{docname}', + dirs_exist_ok=True) + + # Build PDF + cmd = f'make -C doc latexpdf SOURCEDIR={config_folder} BUILDDIR={temp}/pdf/{docname}' + if args.sphinx_build: + cmd += f' SPHINXBUILD={args.sphinx_build}' + subprocess.check_output(cmd, shell=True, env=childenv) + shutil.copyfile(f'{temp}/pdf/{docname}/latex/{docname}.pdf', + f'{output}/{docname}.pdf')