diff options
author | Jonathan Corbet <corbet@lwn.net> | 2022-09-27 22:23:18 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2022-09-27 22:23:18 +0300 |
commit | 3ef859a4f6c97253b75eb53d259b7789fb92d875 (patch) | |
tree | a75904d247af82aed7eb7bae6341b2df659706e8 /Documentation/conf.py | |
parent | 5479d6d4bf122d4b137659559a7bd17784b97b7e (diff) | |
parent | 49beeea7ebdb1d86ba8465e5021d72ad9e9474b8 (diff) | |
download | linux-3ef859a4f6c97253b75eb53d259b7789fb92d875.tar.xz |
Merge branch 'docs-mw' into docs-next
Diffstat (limited to 'Documentation/conf.py')
-rw-r--r-- | Documentation/conf.py | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 255384d094bf..78dd6d1e7b88 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -15,6 +15,18 @@ import sys import os import sphinx +import shutil + +# helper +# ------ + +def have_command(cmd): + """Search ``cmd`` in the ``PATH`` environment. + + If found, return True. + If not found, return False. + """ + return shutil.which(cmd) is not None # Get Sphinx version major, minor, patch = sphinx.version_info[:3] @@ -107,7 +119,32 @@ else: autosectionlabel_prefix_document = True autosectionlabel_maxdepth = 2 -extensions.append("sphinx.ext.imgmath") +# Load math renderer: +# For html builder, load imgmath only when its dependencies are met. +# mathjax is the default math renderer since Sphinx 1.8. +have_latex = have_command('latex') +have_dvipng = have_command('dvipng') +load_imgmath = have_latex and have_dvipng + +# Respect SPHINX_IMGMATH (for html docs only) +if 'SPHINX_IMGMATH' in os.environ: + env_sphinx_imgmath = os.environ['SPHINX_IMGMATH'] + if 'yes' in env_sphinx_imgmath: + load_imgmath = True + elif 'no' in env_sphinx_imgmath: + load_imgmath = False + else: + sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath) + +# Always load imgmath for Sphinx <1.8 or for epub docs +load_imgmath = (load_imgmath or (major == 1 and minor < 8) + or 'epub' in sys.argv) + +if load_imgmath: + extensions.append("sphinx.ext.imgmath") + math_renderer = 'imgmath' +else: + math_renderer = 'mathjax' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] |