From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
LKML <linux-kernel@vger.kernel.org>,
Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 2/3] docs/conf.py: Respect env variable LOAD_IMGMATH
Date: Fri, 5 Aug 2022 23:24:46 +0900 [thread overview]
Message-ID: <aeb5e6fc-4af9-8e3e-a9db-bbcb22d9d913@gmail.com> (raw)
In-Reply-To: <12d078f5-6995-b039-7076-bdb1f372a799@gmail.com>
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 "LOAD_IMGMATH" which overrides the automatic choice
of math renderer for html docs.
LOAD_IMGMATH=yes : Load imgmath even if dvipng is not found
LOAD_IMGMATH=no : Don't load imgmath (fall back to mathjax)
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
---
Documentation/conf.py | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 3ec1f845c839..03613eb59578 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -128,8 +128,20 @@ autosectionlabel_maxdepth = 2
# mathjax is the default math renderer since Sphinx 1.8.
have_latex = have_command('latex', '--version', 'pdfTeX')
have_dvipng = have_command('dvipng', '--version', 'dvipng')
-load_imgmath = ((have_latex and have_dvipng)
- or (major == 1 and minor < 8)
+load_imgmath = have_latex and have_dvipng
+
+# Respect LOAD_IMGMATH (for html docs only)
+if 'LOAD_IMGMATH' in os.environ:
+ opt_load_imgmath = os.environ['LOAD_IMGMATH']
+ if 'yes' in opt_load_imgmath:
+ load_imgmath = True
+ elif 'no' in opt_load_imgmath:
+ load_imgmath = False
+ else: # otherwide, auto selection
+ pass
+
+# 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:
--
2.25.1
next prev parent reply other threads:[~2022-08-05 14:24 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-05 14:21 [PATCH 0/3] docs: conf.py: Reduce texlive dependency Akira Yokosawa
2022-08-05 14:22 ` [PATCH 1/3] docs/conf.py: Treat mathjax as fallback math renderer Akira Yokosawa
2022-08-05 14:24 ` Akira Yokosawa [this message]
2022-08-05 20:35 ` [PATCH 2/3] docs/conf.py: Respect env variable LOAD_IMGMATH Mauro Carvalho Chehab
2022-08-05 14:26 ` [PATCH 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading Akira Yokosawa
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aeb5e6fc-4af9-8e3e-a9db-bbcb22d9d913@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).