linux-kernel - Re: [PATCH] docs: Update Sphinx requirements

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: <550fe790-b18d-f882-4c70-477b596facc7@gmail.com>
Date:   Tue, 16 Nov 2021 10:37:31 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Federico Vaga <federico.vaga@...a.pv.it>,
        Alex Shi <alexs@...nel.org>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: Update Sphinx requirements

On Mon, 15 Nov 2021 02:48:19 -0700
Jonathan Corbet wrote:
> Akira Yokosawa <akiyks@...il.com> writes:
> 
>> Subject: [PATCH] docs: Update Sphinx requirements
>>
>> Commit f546ff0c0c07 ("Move our minimum Sphinx version to 1.7") raised
>> the minimum version to 1.7.
>>
>> For pdfdocs, sphinx_pre_install says:
>>
>>     note: If you want pdf, you need at least Sphinx 2.4.4.
>>
>> , and current requirements.txt installs Sphinx 2.4.4.
>>
>> Update Sphinx versions mentioned in docs and remove a note on earlier
>> Sphinx versions.
> 
> It may be time to consider raising the minimum sphinx version
> overall...

There is one thing we need to address (you might well be aware of).

Our Documentation/conf.py is not compatible for hrmldocs with
the combination sphinx_rtd_theme 1.0.0 and Sphinx >= 3.0.
This issue is the same as the one reported at:
    https://github.com/readthedocs/sphinx_rtd_theme/issues/1240
    "No stylesheet after upgrading to 1.0.0"

I tried the fix suggested there (html_css_files option),
and a stylesheet can be generated.
But the resulting html pages look quite different from the one
you see at https://www.kernel.org/doc/html/latest/ with the sans
font for text and distracting look of monospaced strings.

You can see a screenshot of such a page at
    https://fars.ee/nkkZ

I guess there should be some knobs of Sphinx for customizing
the style, but have not figured them out.

Thoughts?

        Thanks, Akira

>              meanwhile, though, I've applied this, thanks. 
> 
> jon
>