docs/source/conf.py

1 # Configuration file for the Sphinx documentation builder.
3 # For the full list of built-in configuration values, see the documentation:
4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6 # -- Path setup --------------------------------------------------------------
23 from sphinx import __version__ as sphinx_version
24 from sphinx.ext.napoleon.docstring import NumpyDocstring
30 # FIXME: allow building from build?
32 # -- Project information -----------------------------------------------------
33 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
56             version_re = re.compile(rf'#define\s+{release_macro}\s+([-]*\d+)')
70 # -- General configuration ---------------------------------------------------
71 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
74     'sphinx.ext.autodoc',
75     'sphinx.ext.autosummary',
76     'sphinx.ext.intersphinx',
77     'sphinx.ext.napoleon',
78     'sphinx.ext.extlinks',
119 ):  # https://github.com/sphinx-doc/sphinx/issues/12589
122 # Links depends on the actual branch -> release or main
123 www = f'https://gitlab.com/petsc/petsc/-/tree/{get_doc_branch()}'
207     from sphinx.domains.python import PythonDomain
213     from sphinx.ext import autodoc
214     from sphinx.util import inspect
215     from sphinx.util import typing
413 # -- Options for HTML output -------------------------------------------------
414 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
422     'footer_end': ['theme-version', 'last-updated'],
425 …subprocess.check_output(['git', 'describe', '--always']).strip().decode('utf-8')  # noqa: S603, S6…
427 html_last_updated_fmt = r'%Y-%m-%dT%H:%M:%S%z (' + git_describe_version + ')'
429 # -- Options for HTMLHelp output ------------------------------------------
432 htmlhelp_basename = f'{package}-man'
435 # -- Options for LaTeX output ---------------------------------------------
448 # -- Options for manual page output ---------------------------------------
454 # -- Options for Texinfo output -------------------------------------------
471 # -- Options for Epub output ----------------------------------------------