From: Randy Dunlap <rdunlap@infradead.org>
To: Akira Yokosawa <akiyks@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 2/2] docs/conf.py: Respect env variable SPHINX_IMGMATH
Date: Sat, 27 Aug 2022 17:38:41 -0700 [thread overview]
Message-ID: <2032102a-e2d3-6105-f4e6-bba7decdbb66@infradead.org> (raw)
In-Reply-To: <5a582b2b-d51c-a062-36b2-19479cf68fab@gmail.com>
Hi Akira,
On 8/26/22 21:38, Akira Yokosawa wrote:
> 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)
Please add SPHINX_IMGMATH to Documentation/doc-guide/sphinx.rst
(I guess), where other Sphinx environment variables are listed.
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> Changes since v2:
> - Emit warning on unknown setting of SPHINX_IMGMATH.
>
> Changes since v1:
> - No logical changes.
> - Renames:
> LOAD_IMGMATH -> SPHINX_IMGMATH (Mauro),
> opt_load_imgmath -> env_sphinx_imgmath.
> - Acked-by from Mauro.
> --
> Documentation/conf.py | 16 ++++++++++++++--
> 1 file changed, 14 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index c4aaedd96220..9678a8215457 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -124,8 +124,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:
thanks.
--
~Randy
next prev parent reply other threads:[~2022-08-28 0:38 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-27 4:35 [PATCH v3 0/2] docs: conf.py: Reduce texlive dependency Akira Yokosawa
2022-08-27 4:37 ` [PATCH v3 1/2] docs/conf.py: Treat mathjax as fallback math renderer Akira Yokosawa
2022-08-29 16:59 ` Jonathan Corbet
2022-08-27 4:38 ` [PATCH v3 2/2] docs/conf.py: Respect env variable SPHINX_IMGMATH Akira Yokosawa
2022-08-28 0:38 ` Randy Dunlap [this message]
2022-08-28 3:47 ` Akira Yokosawa
2022-08-28 4:59 ` Randy Dunlap
2022-08-29 16:52 ` [PATCH v3 0/2] docs: conf.py: Reduce texlive dependency Jonathan Corbet
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=2032102a-e2d3-6105-f4e6-bba7decdbb66@infradead.org \
--to=rdunlap@infradead.org \
--cc=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
all inboxes | Powered by JetHome®