summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorAkira Yokosawa <akiyks@gmail.com>2022-08-27 13:38:17 +0900
committerJonathan Corbet <corbet@lwn.net>2022-09-27 13:21:43 -0600
commit3b384e95642c0f01a34525a71b6a5a4826934b75 (patch)
tree08ea046bdacf5be3b009c5944953e8b0e965b128 /Documentation
parent6b0d3e7c5888d2ec0f5527ee699265dc852a5faa (diff)
downloadlinux-3b384e95642c0f01a34525a71b6a5a4826934b75.tar.bz2
docs/conf.py: Respect env variable SPHINX_IMGMATH
On some distros with coarse-grained packaging policy, dvipng is installed along with latex. In such cases, math rendering will use imgmath by default. It is possible to override the choice by specifying the option string of "-D html_math_renderer='mathjax'" to sphinx-build (Sphinx >= 1.8). To provide developers an easier-to-use knob, add code for an env variable "SPHINX_IMGMATH" which overrides the automatic choice of math renderer for html docs. SPHINX_IMGMATH=yes : Load imgmath even if dvipng is not found SPHINX_IMGMATH=no : Don't load imgmath (fall back to mathjax) Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/5a582b2b-d51c-a062-36b2-19479cf68fab@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/conf.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py
index f12eb51235da..cdcc8e0f46a6 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -123,8 +123,20 @@ autosectionlabel_maxdepth = 2
# 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)
- or (major == 1 and minor < 8)
+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: