petsc/doc/conf.py

1 # Configuration file for the Sphinx documentation builder.
4 #   http://www.sphinx-doc.org/en/master/config
27     print("-----------------------------------------------------------------------------")
32     print("-----------------------------------------------------------------------------")
36 # -- Project information -------------------------------------------------------
39 copyright = '1991-%d, UChicago Argonne, LLC and the PETSc Development Team' % datetime.date.today()…
46     petsc_release_flag = re.search(' PETSC_VERSION_RELEASE[ ]*([0-9]*)',buf).group(1)
47     major_version      = re.search(' PETSC_VERSION_MAJOR[ ]*([0-9]*)',buf).group(1)
48     minor_version      = re.search(' PETSC_VERSION_MINOR[ ]*([0-9]*)',buf).group(1)
49     subminor_version   = re.search(' PETSC_VERSION_SUBMINOR[ ]*([0-9]*)',buf).group(1)
51 …describe_version = subprocess.check_output(['git', 'describe', '--always']).strip().decode('utf-8')
60 # -- General configuration -----------------------------------------------------
67 exclude_patterns = ['_build*', 'images', 'Thumbs.db', '.DS_Store','community/meetings/pre-2023']
71 # -- Extensions ----------------------------------------------------------------
91 remove_from_toctrees = ['manualpages/*/[A-Z]*','changes/2*','changes/3*']
96 # -- Options for HTML output ---------------------------------------------------
100 html_logo_light = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc-TAO', 'web', 'PETSc-TAO…
101 html_logo_dark = os.path.join('images', 'logos', 'PETSc_TAO_logos', 'PETSc-TAO', 'web', 'PETSc-TAO_…
106 # https://pydata-sphinx-theme.readthedocs.io/en/v0.12.0/user_guide/styling.html
116             "icon": "fab fa-gitlab",
120     "footer_end": ["theme-version", "last-updated"],
121 #    "secondary_sidebar_items" : ["edit-this-page"],
131   git_ref = subprocess.check_output(["git", "rev-parse", "HEAD"]).rstrip()
132   git_ref_release = subprocess.check_output(["git", "rev-parse", "origin/release"]).rstrip()
148 html_last_updated_fmt = r'%Y-%m-%dT%H:%M:%S%z (' + git_describe_version + ')'
151 # -- Options for LaTeX output --------------------------------------------------
183 # -- Setup and event callbacks -------------------------------------------------
186     app.connect('builder-inited', builder_init_handler)
187     app.connect('build-finished', build_finished_handler)
202     print("    Running Sphinx on PETSc " + ptype)
208     print("Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - xtime))
233         print("Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))
243         print("Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))
247 #   The following two scripts are needed because the Sphinx html and dirhtml builds save the output…
248 #   files at different levels of the directory hierarchy. file.rst/md -> file.html with html but
249 #   file.rst/md -> file/index.html with dirhtml and we want both to work correctly using relative l…
253 …are auto-generated by c2html outside of Sphinx so Sphinx cannot directly handle those links for us…
254 …    We use the string PETSC_DOC_OUT_ROOT_PLACEHOLDER in URLs in the Sphinx .rst files as a stand in
255 …for the root directory that needs to be constructed based on if the Sphinx build is html or dirhtml
263         print("Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))
269 …hierarchy. The format of the directory location needs to be different for the Sphinx html and dirh…
277     print("Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))
282     # petsc4py needs to be built to build petsc4py docs via introspection
283     command = ['make', '-f', 'makefile', 'libs',
285                'PETSC_ARCH=arch-docs']
292 …t("End building library for petsc4py docs Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))
297                'PETSC_ARCH=arch-docs',
304     print("End petsc4py docs Time: "+str(time.clock_gettime(time.CLOCK_REALTIME) - x))