From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1851) id 41AA6385703A; Tue, 26 Jul 2022 12:43:51 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 41AA6385703A 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-v7)] sphinx: update baseconf.py file X-Act-Checkin: gcc X-Git-Author: Martin Liska X-Git-Refname: refs/users/marxin/heads/sphinx-v7 X-Git-Oldrev: e71d6aa5c4f40f54760a4585acf74d79bb5d009d X-Git-Newrev: ab4aed89362ab25ee168a5cd071574920867ef22 Message-Id: <20220726124351.41AA6385703A@sourceware.org> Date: Tue, 26 Jul 2022 12:43:51 +0000 (GMT) X-BeenThere: gcc-cvs@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-cvs mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 26 Jul 2022 12:43:51 -0000 https://gcc.gnu.org/g:ab4aed89362ab25ee168a5cd071574920867ef22 commit ab4aed89362ab25ee168a5cd071574920867ef22 Author: Martin Liska Date: Tue Mar 15 12:09:29 2022 +0100 sphinx: update baseconf.py file Diff: --- doc/baseconf.py | 57 +++++++++++++++++++++++++-------------------------------- 1 file changed, 25 insertions(+), 32 deletions(-) diff --git a/doc/baseconf.py b/doc/baseconf.py index 0978da7823e..7a123167a49 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 subprocess +import time import sys # sys.path.insert(0, os.path.abspath('.')) @@ -22,11 +22,10 @@ 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, './objdir') +gcc_srcdir = os.path.join(folder, '..', 'gcc') -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() @@ -34,22 +33,15 @@ def __read_file(name): 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 +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') -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', '(GCC)') -BUGURL = os.getenv('BUGURL', 'https://gcc.gnu.org/bugs/') +YEAR = time.strftime('%Y') # The short X.Y version. version = gcc_BASEVER @@ -69,10 +61,14 @@ needs_sphinx = '5.1' rst_epilog = ''' .. |gcc_version| replace:: %s -.. |package_version| replace:: %s -.. |bugurl| replace:: %s -.. |needs_sphinx| replace:: %s -''' % (gcc_BASEVER, VERSION_PACKAGE, BUGURL, needs_sphinx) +.. |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 # -- General configuration --------------------------------------------------- @@ -115,18 +111,14 @@ html_theme_options = { 'navigation_with_keys': True, } -html_logo = '../logo.svg' +html_logo = os.path.join(folder, 'logo.svg') -html_favicon = '../favicon.ico' +html_favicon = os.path.join(folder, 'favicon.ico') html_last_updated_fmt = '' -html_context = { - 'commit': __get_git_revision () -} - html_static_path = [ - '../_static' + os.path.join(folder, '_static') ] html_css_files = [ @@ -139,12 +131,13 @@ man_pages = [] # FIXME: handle WARNINGs: unknown option issues and cross refs suppress_warnings = [ 'ref.option', + 'ref.ref' ] # Use xelatex by default latex_engine = 'xelatex' -latex_logo = '../logo.pdf' +latex_logo = os.path.join(folder, 'logo.pdf') # TODO: Remove once xindy works in an openSUSE container latex_use_xindy = False @@ -174,7 +167,7 @@ option_emphasise_placeholders = True # Cross manual reference mapping intersphinx_mapping = {} -for manual in ['cpp', 'cppinternals', 'gfortran', 'gcc', 'gccgo', 'gccint', 'gdc', +for manual in ['cpp', 'cppinternals', 'fortran', 'gcc', 'gccgo', 'gccint', 'gdc', 'gfc-internals', 'gnat-style', 'gnat_rm', 'gnat_ugn', 'install', 'libgccjit', 'libgomp', 'libiberty', 'libitm', 'libquadmath']: - intersphinx_mapping[manual] = (f'https://splichal.eu/scripts/sphinx/{manual}/_build/html/', None) + intersphinx_mapping[manual] = (f'https://gcc.gnu.org/onlinedocs/{manual}/', None)