public inbox for gcc-cvs@sourceware.org help / color / mirror / Atom feed
From: Martin Liska <marxin@gcc.gnu.org> To: gcc-cvs@gcc.gnu.org Subject: [gcc(refs/users/marxin/heads/sphinx-v7)] sphinx: update baseconf.py file Date: Wed, 27 Jul 2022 14:47:26 +0000 (GMT) [thread overview] Message-ID: <20220727144726.713C73856DCD@sourceware.org> (raw) https://gcc.gnu.org/g:345dbaedfedc6e499c7b79bf05b67dcc3638cf77 commit 345dbaedfedc6e499c7b79bf05b67dcc3638cf77 Author: Martin Liska <mliska@suse.cz> 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)
next reply other threads:[~2022-07-27 14:47 UTC|newest] Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-07-27 14:47 Martin Liska [this message] -- strict thread matches above, loose matches on Subject: below -- 2022-08-01 11:51 Martin Liska 2022-08-01 4:02 Martin Liska 2022-07-28 13:18 Martin Liska 2022-07-28 12:39 Martin Liska 2022-07-28 12:22 Martin Liska 2022-07-27 12:17 Martin Liska 2022-07-26 12:50 Martin Liska 2022-07-26 12:43 Martin Liska 2022-07-26 12:42 Martin Liska
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20220727144726.713C73856DCD@sourceware.org \ --to=marxin@gcc.gnu.org \ --cc=gcc-cvs@gcc.gnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).