lkml.org 
[lkml]   [2022]   [Aug]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/3] docs/conf.py: Respect env variable LOAD_IMGMATH
Em Fri, 5 Aug 2022 23:24:46 +0900
Akira Yokosawa <akiyks@gmail.com> escreveu:

> 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)

I would use a var name starting with SPHINX, like SPHINX_IMGMATH.

Anyway, for this entire series:

Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>

>
> 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:



Thanks,
Mauro

\
 
 \ /
  Last update: 2022-08-05 22:59    [W:0.035 / U:0.264 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site