From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1851) id 1F7143883029; Mon, 14 Nov 2022 08:39:44 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 1F7143883029 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1668415194; bh=ah7RUvMqprqBl4R5JJzdTQR/ATJvzKcn3iYX4f/HGYQ=; h=From:To:Subject:Date:From; b=gW6pErkwy9WidST3gjZrBJuXvoOuZbFZglTF+b3AFdp9TMRqMzKi5diUWNhqu1TJ2 eZIyaGD8Z1bShyjIADAVo2msEB7Hu1+y5UnYM41MLQLYFGc5VeGgN8m/LoZ6wor+zg TW24MwR9gSom1l0ugzsXEXMjnOeUJvqasy9boxc0= MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="utf-8" From: Martin Liska To: gcc-cvs@gcc.gnu.org Subject: [gcc r13-3998] Revert "sphinx: update baseconf.py file" X-Act-Checkin: gcc X-Git-Author: Martin Liska X-Git-Refname: refs/heads/master X-Git-Oldrev: d92b5067f0af8b34f753e463cc7538466190c2db X-Git-Newrev: de133793c274cfd831b17bed50e7375ac4892e4b Message-Id: <20221114083954.1F7143883029@sourceware.org> Date: Mon, 14 Nov 2022 08:39:44 +0000 (GMT) List-Id: https://gcc.gnu.org/g:de133793c274cfd831b17bed50e7375ac4892e4b commit r13-3998-gde133793c274cfd831b17bed50e7375ac4892e4b Author: Martin Liska Date: Sun Nov 13 21:59:59 2022 +0100 Revert "sphinx: update baseconf.py file" This reverts commit 8dc319eb495d6fa742a265dfa12dc75bf3576d07. Diff: --- doc/baseconf.py | 75 +++++++++++++++++++++++++++++++++------------------------ 1 file changed, 44 insertions(+), 31 deletions(-) diff --git a/doc/baseconf.py b/doc/baseconf.py index f80fdabc8b0..2eea8298dae 100644 --- a/doc/baseconf.py +++ b/doc/baseconf.py @@ -11,7 +11,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # import os -import time +import subprocess import sys # sys.path.insert(0, os.path.abspath('.')) @@ -22,16 +22,28 @@ sys.setrecursionlimit(2000) # The full version, including alpha/beta/rc tags +# FIXME folder = os.path.dirname(os.path.realpath(__file__)) -gcc_srcdir = os.path.join(folder, '..', 'gcc') +gcc_srcdir = os.path.join(folder, './objdir') -def read_file(name): + +def __read_file(name): path = os.path.join(gcc_srcdir, name) if os.path.exists(path): return open(path).read().strip() else: return '' + +def __get_git_revision(): + try: + r = subprocess.check_output('git rev-parse --short HEAD', shell=True, encoding='utf8', + stderr=subprocess.DEVNULL) + return r.strip() + except subprocess.CalledProcessError: + return None + + def __get_builder_name(): if '-b' in sys.argv: return sys.argv[sys.argv.index('-b') + 1] @@ -39,17 +51,15 @@ def __get_builder_name(): return None -gcc_BASEVER = read_file('BASE-VER') -gcc_DEVPHASE = read_file('DEV-PHASE') -gcc_DATESTAMP = read_file('DATESTAMP') -gcc_REVISION = read_file('REVISION') +gcc_BASEVER = __read_file('BASE-VER') +gcc_DEVPHASE = __read_file('DEV-PHASE') +gcc_DATESTAMP = __read_file('DATESTAMP') +gcc_REVISION = __read_file('REVISION') -VERSION_PACKAGE = os.getenv('VERSION_PACKAGE') -BUGURL = os.getenv('BUGURL') +VERSION_PACKAGE = os.getenv('VERSION_PACKAGE', '(GCC)') +BUGURL = os.getenv('BUGURL', 'https://gcc.gnu.org/bugs/') MONOCHROMATIC = os.getenv('MONOCHROMATIC') -YEAR = time.strftime('%Y') - # The short X.Y version. version = gcc_BASEVER @@ -70,14 +80,10 @@ needs_sphinx = '5.3' rst_epilog = ''' .. |gcc_version| replace:: %s -.. |needs_sphinx| replace:: %s\n -''' % (gcc_BASEVER, needs_sphinx) - -if BUGURL: - rst_epilog += '.. |bugurl| replace:: %s\n' % BUGURL - -if VERSION_PACKAGE: - rst_epilog += '.. |package_version| replace:: %s\n' % VERSION_PACKAGE +.. |package_version| replace:: %s +.. |bugurl| replace:: %s +.. |needs_sphinx| replace:: %s +''' % (gcc_BASEVER, VERSION_PACKAGE, BUGURL, needs_sphinx) # -- General configuration --------------------------------------------------- @@ -124,14 +130,18 @@ html_theme_options = { 'navigation_with_keys': True, } -html_logo = os.path.join(folder, 'logo.svg') +html_logo = '../logo.svg' -html_favicon = os.path.join(folder, 'favicon.ico') +html_favicon = '../favicon.ico' html_last_updated_fmt = '' +html_context = { + 'commit': __get_git_revision() +} + html_static_path = [ - os.path.join(folder, '_static') + '../_static' ] html_css_files = [ @@ -149,7 +159,7 @@ suppress_warnings = [ # Use xelatex by default latex_engine = 'xelatex' -latex_logo = os.path.join(folder, 'logo.pdf') +latex_logo = '../logo.pdf' latex_elements = { 'pointsize': '11pt', @@ -171,11 +181,14 @@ OuterLinkColor={rgb}{0.0, 0.2, 0.6}, latex_table_style = ['colorrows'] -# makeindex is much common on older systems -latex_use_xindy = False - texinfo_cross_references = False +texinfo_elements = {'preamble': """ +@definfoenclose strong,*,* +@definfoenclose emph,',' +""" +} + # Use default as RTD theme uses default as well pygments_style = 'bw' if MONOCHROMATIC else 'default' @@ -188,13 +201,13 @@ linkcheck_ignore = [ ] USER_LEVEL_DOCS = ('install', 'gcc', 'gfortran', 'cpp', 'gnat_rm', 'gnat_ugn', - 'gccgo', 'gdc', 'libgomp', 'libquadmath', 'libitm', 'libgccjit') -INTERNAL_DOCS = ('gccint', 'cppinternals', 'gfc-internals', 'gnat-style', 'libiberty') + 'gccgo', 'libgomp', 'libquadmath', 'libgccjit') +INTERNAL_DOCS = ('gccint', 'cppinternals', 'gfc-internals', 'gnat-style') # Cross manual reference mapping intersphinx_mapping = {} for manual in USER_LEVEL_DOCS + INTERNAL_DOCS: - intersphinx_mapping[manual] = (f'https://gcc.gnu.org/onlinedocs/{manual}/', None) + intersphinx_mapping[manual] = (f'https://splichal.eu/scripts/sphinx/{manual}/_build/html/', None) # Custom references extlinks = { @@ -213,5 +226,5 @@ def set_common(name, module): module['todo_include_todos'] = True module['tags'].add('development') - html_theme_options['source_edit_link'] = f'https://gcc.gnu.org/onlinedocs/{name}' \ - '/_sources/{filename}.txt' + html_theme_options['source_edit_link'] = f'https://splichal.eu/scripts/sphinx/{name}' \ + '/_build/html/_sources/{filename}.txt'