Re: [PATCH] docs: Update Sphinx requirements

From: Akira Yokosawa
Date: Tue Nov 16 2021 - 00:38:54 EST


On Tue, 16 Nov 2021 10:37:31 +0900
Akira Yokosawa wrote:
> On Mon, 15 Nov 2021 02:48:19 -0700
> Jonathan Corbet wrote:
>> Akira Yokosawa <akiyks@xxxxxxxxx> 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

Having looked at https://sphinx-themes.org/sample-sites/sphinx-rtd-theme/,
I'm wondering if the screenshot above is exactly what you'd
expect by using the theme in the first place.

Hmm??

Thanks, Akira

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