xref: /petsc/doc/conf.py (revision eee954682a6abb1a7ac141dbd0723ecb4ff6b1e5) 
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 = '$ '
77
78bibtex_bibfiles = ['petsc.bib']
79
80# -- Options for HTML output ---------------------------------------------------
81
82html_theme = 'pydata_sphinx_theme'
83
84html_theme_options = {
85    "icon_links": [
86        {
87            "name": "GitLab",
88            "url": "https://gitlab.com/petsc/petsc",
89            "icon": "fab fa-gitlab",
90        },
91    ],
92    "use_edit_page_button": True,
93    "footer_items": ["copyright", "sphinx-version", "last-updated"],
94}
95
96html_context = {
97    "github_url": "https://gitlab.com",
98    "github_user": "petsc",
99    "github_repo": "petsc",
100    "github_version": "release",
101    "doc_path": "doc",
102}
103
104html_logo = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc-TAO', 'web', 'PETSc-TAO_RGB.svg')
105html_favicon = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc', 'petsc_favicon.png')
106html_last_updated_fmt = r'%Y-%m-%dT%H:%M:%S%z (' + git_describe_version + ')'
107
108
109
110# -- Options for LaTeX output --------------------------------------------------
111latex_engine = 'xelatex'
112
113# How to arrange the documents into LaTeX files, building only the manual.
114latex_documents = [
115        ('docs/manual/index', 'manual.tex', 'PETSc/TAO Users Manual', author, 'manual', False)
116        ]
117
118latex_additional_files = [
119    'images/docs/manual/anl_tech_report/ArgonneLogo.pdf',
120    'images/docs/manual/anl_tech_report/ArgonneReportTemplateLastPage.pdf',
121    'images/docs/manual/anl_tech_report/ArgonneReportTemplatePage2.pdf',
122    'docs/manual/anl_tech_report/first.inc',
123    'docs/manual/anl_tech_report/last.inc',
124]
125
126latex_elements = {
127    'maketitle': r'\newcommand{\techreportversion}{%s}' % version +
128r'''
129\input{first.inc}
130''',
131    'printindex': r'''
132\printindex
133\input{last.inc}
134''',
135    'fontpkg': r'''
136\setsansfont{DejaVu Sans}
137\setmonofont{DejaVu Sans Mono}
138''',
139    'tableofcontents' : r''
140}
141
142
143# -- Setup and event callbacks -------------------------------------------------
144
145# Trigger a build of the "classic" docs
146def _build_classic_docs(app):
147    build_classic_docs.main()
148
149
150def builder_init_handler(app):
151    _build_classic_docs(app)
152
153
154def _add_version_header(app, exception):
155    if exception is None and app.builder.name.endswith('html'):
156        print("============================================")
157        print("    Adding version to classic man pages, from conf.py")
158        print("============================================")
159        add_version_header.add_version_header(os.path.join(app.outdir, "docs", "manualpages"), release)
160
161
162def _copy_classic_docs(app, exception):
163    if exception is None and app.builder.name.endswith('html'):
164        print("============================================")
165        print("    Copying classic docs from conf.py       ")
166        print("============================================")
167        build_classic_docs.copy_classic_docs(app.outdir)
168
169
170def _fix_links(app, exception):
171    if exception is None and app.builder.name.endswith('html'):
172        print("============================================")
173        print("    Fixing relative links from conf.py      ")
174        print("============================================")
175        make_links_relative.make_links_relative(app.outdir)
176
177
178def build_finished_handler(app, exception):
179    _copy_classic_docs(app, exception)
180    _fix_links(app, exception)
181    _add_version_header(app, exception)
182    if app.builder.name.endswith('html'):
183        print("==========================================================================")
184        print("    open %s/index.html in your browser to view the documentation " % app.outdir)
185        print("==========================================================================")
186
187
188def setup(app):
189    app.connect('builder-inited', builder_init_handler)
190    app.connect('build-finished', build_finished_handler)
191    app.add_css_file('css/pop-up.css')
192