linux-kernel - Re: [PATCH v3 2/2] docs/conf.py: Respect env variable SPHINX

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <a79687c7-929e-19d1-97fc-9a2ecf39d38d@infradead.org>
Date:   Sat, 27 Aug 2022 21:59:42 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     linux-doc@...r.kernel.org,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Subject: Re: [PATCH v3 2/2] docs/conf.py: Respect env variable SPHINX_IMGMATH



On 8/27/22 20:47, Akira Yokosawa wrote:
> Hi Randy,  thank you for looking into this!
> 
> On Sat, 27 Aug 2022 17:38:41 -0700, Randy Dunlap wrote:
>> 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.
> 
> Right.
> As I mentioned in the coverletter, (quoted below):
> 
>> I mentioned in the thread of [3] that imgmath can generate scalable
>> math images in SVG.
>>
>> My plan was to implement that option as well.  But during tests under
>> Fedora/CentOS/openSUSE, I encountered a couple of warnings from dvisvgm.
>> That would be regressions on existing systems which happen to have
>> not-working dvisvgm along with working dvipng.  I'm thinking of adding
>> the SVG option later if I can figure out the minimal requirement for
>> dvisvgm under imgmath.
> 
> , I'm working on follow-up changes related to SPHINX_IMGMATH.
> 
> My plan is to update related docs and help text in Makefile when I manage
> the SVG option. At that time, SPHINX_IMGMATH will have additional options
> like 'svg' and 'png'.
> 
> Hopefully, such follow-up changes can make the v6.1 merge window.
> 
> Does this plan work for you?

Ok, yes, sure, no problem.

Thanks.

-- 
~Randy