xref: /petsc/doc/conf.py (revision a676a84c0b5022ee63103eccaa0bdd340896d14c) 
1# Configuration file for the Sphinx documentation builder.
2#
3# For information on options, see
4#   http://www.sphinx-doc.org/en/master/config
5#
6# You may also find it helpful to run "sphinx-quickstart" in a scratch
7# directory and read the comments in the automatically-generated conf.py file.
8
9import os
10import sys
11import subprocess
12import re
13import datetime
14
15sys.path.append(os.getcwd())
16sys.path.append(os.path.abspath('./ext'))
17
18import add_version_header
19import build_classic_docs
20import make_links_relative
21
22
23if not os.path.isdir("images"):
24    print("-----------------------------------------------------------------------------")
25    print("ERROR")
26    print("images directory does not seem to exist.")
27    print("To clone the required repository, try")
28    print("   make images")
29    print("-----------------------------------------------------------------------------")
30    raise Exception("Aborting because images missing")
31
32
33# -- Project information -------------------------------------------------------
34
35project = 'PETSc'
36copyright = '1991-%d, UChicago Argonne, LLC and the PETSc Development Team' % datetime.date.today().year
37author = 'The PETSc Development Team'
38
39with open(os.path.join('..', 'include', 'petscversion.h'),'r') as version_file:
40    buf = version_file.read()
41    petsc_release_flag = re.search(' PETSC_VERSION_RELEASE[ ]*([0-9]*)',buf).group(1)
42    major_version      = re.search(' PETSC_VERSION_MAJOR[ ]*([0-9]*)',buf).group(1)
43    minor_version      = re.search(' PETSC_VERSION_MINOR[ ]*([0-9]*)',buf).group(1)
44    subminor_version   = re.search(' PETSC_VERSION_SUBMINOR[ ]*([0-9]*)',buf).group(1)
45
46    git_describe_version = subprocess.check_output(['git', 'describe', '--always']).strip().decode('utf-8')
47    if petsc_release_flag == '0':
48        version = git_describe_version
49        release = git_describe_version
50    else:
51        version = '.'.join([major_version, minor_version])
52        release = '.'.join([major_version,minor_version,subminor_version])
53
54
55# -- General configuration -----------------------------------------------------
56
57needs_sphinx='3.5'
58nitpicky = True  # checks internal links. For external links, use "make linkcheck"
59master_doc = 'index'
60templates_path = ['_templates']
61exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
62highlight_language = 'c'
63numfig = True
64
65# -- Extensions ----------------------------------------------------------------
66
67extensions = [
68    'sphinx_copybutton',
69    'sphinx_panels',
70    'sphinxcontrib.bibtex',
71    'sphinxcontrib.katex',
72    'sphinxcontrib.rsvgconverter',
73    'html5_petsc',
74]
75
76copybutton_prompt_text = r"[>]{1,3}"
77copybutton_prompt_is_regexp = True
78
79bibtex_bibfiles = [
80        os.path.join('bibtex', 'petsc.bib'),
81        os.path.join('bibtex', 'petscapp.bib'),
82        os.path.join('bibtex', 'tao.bib'),
83        os.path.join('bibtex', 'tao_mathprog.bib'),
84]
85
86# -- Options for HTML output ---------------------------------------------------
87
88html_theme = 'pydata_sphinx_theme'
89
90html_theme_options = {
91    "icon_links": [
92        {
93            "name": "GitLab",
94            "url": "https://gitlab.com/petsc/petsc",
95            "icon": "fab fa-gitlab",
96        },
97    ],
98    "use_edit_page_button": True,
99    "footer_items": ["copyright", "sphinx-version", "last-updated"],
100}
101
102html_context = {
103    "github_url": "https://gitlab.com",
104    "github_user": "petsc",
105    "github_repo": "petsc",
106    "github_version": "release",
107    "doc_path": "doc",
108}
109
110html_logo = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc-TAO', 'web', 'PETSc-TAO_RGB.svg')
111html_favicon = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc', 'petsc_favicon.png')
112html_last_updated_fmt = r'%Y-%m-%dT%H:%M:%S%z (' + git_describe_version + ')'
113
114
115
116# -- Options for LaTeX output --------------------------------------------------
117latex_engine = 'xelatex'
118
119# How to arrange the documents into LaTeX files, building only the manual.
120latex_documents = [
121        ('docs/manual/index', 'manual.tex', 'PETSc/TAO Users Manual', author, 'manual', False)
122        ]
123
124latex_additional_files = [
125    'docs/manual/anl_tech_report/ArgonneLogo.pdf',
126    'docs/manual/anl_tech_report/ArgonneReportTemplateLastPage.pdf',
127    'docs/manual/anl_tech_report/ArgonneReportTemplatePage2.pdf',
128    'docs/manual/anl_tech_report/first.inc',
129    'docs/manual/anl_tech_report/last.inc',
130]
131
132latex_elements = {
133    'maketitle': r'\newcommand{\techreportversion}{%s}' % version +
134r'''
135\input{first.inc}
136''',
137    'printindex': r'''
138\printindex
139\input{last.inc}
140''',
141    'fontpkg': r'''
142\setsansfont{DejaVu Sans}
143\setmonofont{DejaVu Sans Mono}
144''',
145    'tableofcontents' : r''
146}
147
148
149# -- Setup and event callbacks -------------------------------------------------
150
151# Trigger a build of the "classic" docs
152def _build_classic_docs(app):
153    build_classic_docs.main()
154
155
156def builder_init_handler(app):
157    _build_classic_docs(app)
158
159
160def _add_version_header(app, exception):
161    if exception is None and app.builder.name.endswith('html'):
162        print("============================================")
163        print("    Adding version to classic man pages, from conf.py")
164        print("============================================")
165        add_version_header.add_version_header(os.path.join(app.outdir, "docs", "manualpages"), release)
166
167
168def _copy_classic_docs(app, exception):
169    if exception is None and app.builder.name.endswith('html'):
170        print("============================================")
171        print("    Copying classic docs from conf.py       ")
172        print("============================================")
173        build_classic_docs.copy_classic_docs(app.outdir)
174
175
176def _fix_links(app, exception):
177    if exception is None and app.builder.name.endswith('html'):
178        print("============================================")
179        print("    Fixing relative links from conf.py      ")
180        print("============================================")
181        make_links_relative.make_links_relative(app.outdir)
182
183
184def build_finished_handler(app, exception):
185    _copy_classic_docs(app, exception)
186    _fix_links(app, exception)
187    _add_version_header(app, exception)
188
189
190def setup(app):
191    app.connect('builder-inited', builder_init_handler)
192    app.connect('build-finished', build_finished_handler)
193    app.add_css_file('css/pop-up.css')
194