]> git.baikalelectronics.ru Git - kernel.git/commit
docs/conf.py: Treat mathjax as fallback math renderer
authorAkira Yokosawa <akiyks@gmail.com>
Sat, 27 Aug 2022 04:37:18 +0000 (13:37 +0900)
committerJonathan Corbet <corbet@lwn.net>
Tue, 27 Sep 2022 19:21:43 +0000 (13:21 -0600)
commit8c176bd959d8d67d601a775723695beea6c2fb84
tree28ea7d09e3edba24bddf796eb79453b356b4fea2
parent9798c95e19844ed34cfb72c535f60725804f9651
docs/conf.py: Treat mathjax as fallback math renderer

Currently, math expressions using the "math::" directive or
the ":math:" role of Sphinx need the imgmath extension for proper
rendering in html and epub builds.
imgmath requires dvipng (and latex).
Otherwise, "make htmldocs" will complain of missing commands.

As a matter of fact, the mathjax extension is loaded by default since
Sphinx v1.8 and it is good enough for html docs without any dependency
on texlive packages.

Stop loading the imgmath extension for html docs unless requirements
for imgmath are met.

To find out whether required commands are available, add a helper
find_command(), which is a wrapper of shutil.which().

For epub docs, keep the same behavior of always loading imgmath.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/a6a877fc-dc93-2bda-a6d3-37001d99942a@gmail.com
[jc: Took out the writing of the math_renderer decision]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/conf.py