sphinx: update baseconf.py file
ChangeLog: * doc/baseconf.py: Port to GCC sources.
This commit is contained in:
Martin Liska
parent
c63539ffe4
commit
8dc319eb49
1 changed files with 31 additions and 44 deletions
|
|
@ -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,28 +22,16 @@ 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()
|
||||
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]
|
||||
|
|
@ -51,15 +39,17 @@ 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', '(GCC)')
|
||||
BUGURL = os.getenv('BUGURL', 'https://gcc.gnu.org/bugs/')
|
||||
VERSION_PACKAGE = os.getenv('VERSION_PACKAGE')
|
||||
BUGURL = os.getenv('BUGURL')
|
||||
MONOCHROMATIC = os.getenv('MONOCHROMATIC')
|
||||
|
||||
YEAR = time.strftime('%Y')
|
||||
|
||||
# The short X.Y version.
|
||||
version = gcc_BASEVER
|
||||
|
||||
|
|
@ -80,10 +70,14 @@ needs_sphinx = '5.3'
|
|||
|
||||
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 ---------------------------------------------------
|
||||
|
||||
|
|
@ -130,18 +124,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 = [
|
||||
|
|
@ -159,7 +149,7 @@ suppress_warnings = [
|
|||
# Use xelatex by default
|
||||
latex_engine = 'xelatex'
|
||||
|
||||
latex_logo = '../logo.pdf'
|
||||
latex_logo = os.path.join(folder, 'logo.pdf')
|
||||
|
||||
latex_elements = {
|
||||
'pointsize': '11pt',
|
||||
|
|
@ -181,13 +171,10 @@ OuterLinkColor={rgb}{0.0, 0.2, 0.6},
|
|||
|
||||
latex_table_style = ['colorrows']
|
||||
|
||||
texinfo_cross_references = False
|
||||
# makeindex is much common on older systems
|
||||
latex_use_xindy = False
|
||||
|
||||
texinfo_elements = {'preamble': """
|
||||
@definfoenclose strong,*,*
|
||||
@definfoenclose emph,','
|
||||
"""
|
||||
}
|
||||
texinfo_cross_references = False
|
||||
|
||||
# Use default as RTD theme uses default as well
|
||||
pygments_style = 'bw' if MONOCHROMATIC else 'default'
|
||||
|
|
@ -201,13 +188,13 @@ linkcheck_ignore = [
|
|||
]
|
||||
|
||||
USER_LEVEL_DOCS = ('install', 'gcc', 'gfortran', 'cpp', 'gnat_rm', 'gnat_ugn',
|
||||
'gccgo', 'libgomp', 'libquadmath', 'libgccjit')
|
||||
INTERNAL_DOCS = ('gccint', 'cppinternals', 'gfc-internals', 'gnat-style')
|
||||
'gccgo', 'gdc', 'libgomp', 'libquadmath', 'libitm', 'libgccjit')
|
||||
INTERNAL_DOCS = ('gccint', 'cppinternals', 'gfc-internals', 'gnat-style', 'libiberty')
|
||||
|
||||
# Cross manual reference mapping
|
||||
intersphinx_mapping = {}
|
||||
for manual in USER_LEVEL_DOCS + INTERNAL_DOCS:
|
||||
intersphinx_mapping[manual] = (f'https://splichal.eu/scripts/sphinx/{manual}/_build/html/', None)
|
||||
intersphinx_mapping[manual] = (f'https://gcc.gnu.org/onlinedocs/{manual}/', None)
|
||||
|
||||
# Custom references
|
||||
extlinks = {
|
||||
|
|
@ -226,5 +213,5 @@ def set_common(name, module):
|
|||
module['todo_include_todos'] = True
|
||||
module['tags'].add('development')
|
||||
|
||||
html_theme_options['source_edit_link'] = f'https://splichal.eu/scripts/sphinx/{name}' \
|
||||
'/_build/html/_sources/{filename}.txt'
|
||||
html_theme_options['source_edit_link'] = f'https://gcc.gnu.org/onlinedocs/{name}' \
|
||||
'/_sources/{filename}.txt'
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue