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-final)] sphinx: update baseconf.py file
Date: Tue,  8 Nov 2022 12:06:00 +0000 (GMT)	[thread overview]
Message-ID: <20221108120606.AF5233858C56@sourceware.org> (raw)

https://gcc.gnu.org/g:077d00e58d7120b7266e9371e974938738cb17c0

commit 077d00e58d7120b7266e9371e974938738cb17c0
Author: Martin Liska <mliska@suse.cz>
Date:   Mon Nov 7 12:59:25 2022 +0100

    sphinx: update baseconf.py file
    
    ChangeLog:
    
            * doc/baseconf.py: Port to GCC sources.

Diff:
---
 doc/baseconf.py | 71 +++++++++++++++++++++++----------------------------------
 1 file changed, 29 insertions(+), 42 deletions(-)

diff --git a/doc/baseconf.py b/doc/baseconf.py
index 2eea8298dae..2f97ca0a47b 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,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'
@@ -207,7 +194,7 @@ 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://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'

             reply	other threads:[~2022-11-08 12:06 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-08 12:06 Martin Liska [this message]
  -- strict thread matches above, loose matches on Subject: below --
2022-11-08 14:42 Martin Liska
2022-11-08 14:35 Martin Liska
2022-11-08 14:34 Martin Liska
2022-11-08 11:38 Martin Liska
2022-11-08 10:20 Martin Liska
2022-11-07 14:33 Martin Liska
2022-11-07 14:18 Martin Liska
2022-11-07 14:06 Martin Liska
2022-11-07 13:00 Martin Liska
2022-11-07 12:37 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=20221108120606.AF5233858C56@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: link
Be 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).