LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Randy Dunlap <rdunlap@infradead.org>,
	Akira Yokosawa <akiyks@gmail.com>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Hans Verkuil <hverkuil@xs4all.nl>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Subject: Re: [PATCH] docs: conf.py: fix support for Readthedocs v 1.0.0
Date: Sat, 27 Nov 2021 00:03:04 +0200	[thread overview]
Message-ID: <87sfvik21z.fsf@intel.com> (raw)
In-Reply-To: <59f64802-c3dc-74cd-8f35-878e3fac64e2@infradead.org>

On Fri, 26 Nov 2021, Randy Dunlap <rdunlap@infradead.org> wrote:
> On 11/26/21 6:33 AM, Akira Yokosawa wrote:
>> Hi Mauro,
>> 
>> On Fri, Nov 26, 2021 at 11:50:53AM +0100, Mauro Carvalho Chehab wrote:
>>> As described at:
>>> 	https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs
>>>
>>> since Sphinx 1.8, the standard way to setup a custom theme is
>>> to use html_css_files. While using html_context is OK with RTD
>>> 0.5.2, it doesn't work with 1.0.0, causing the theme to not load,
>>> producing a very weird html.
>>>
>>> Tested with:
>>> 	- Sphinx 2.4.4 + sphinx-rtd-theme 0.5.2
>>> 	- Sphinx 2.4.4 + sphinx-rtd-theme 1.0.0
>>> 	- Sphinx 4.3.0 + sphinx-rtd-theme 1.0.0
>>>
>>> Reported-by: Hans Verkuil <hverkuil@xs4all.nl>
>>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>>> ---
>>>   Documentation/conf.py | 13 +++++++++----
>>>   1 file changed, 9 insertions(+), 4 deletions(-)
>> 
>> So I have an issue with this simple change.
>> As I said to Jon in another thread [1], in which Jon didn't show any
>> interest, this update changes the look of generated HTML pages
>> (I should say) rather drastically, and it looks quite distracting
>> for my eyes.  The style might be acceptable for API documentations,
>> but kernel-doc has abundant natural language contents.
>
> I agree 100% that the sans serif font is not desirable and not as
> easy on the eyes as the serif font is.
> Hopefully there is a way to change that.

Taking a step back, choosing the sphinx-rtd-theme to begin with was
purely arbitrary, I didn't put much effort into checking the
alternatives, and as far as I recall, neither did Jon. There were more
pressing issues at the time to get the documentation generation ball
rolling at all.

Obviously anyone can change the theme for themselves, and I guess the
question is rather what the default is, and, subsequently, what gets
used at [1].

I haven't followed the development on this closely, but I am somewhat
surprised at the amount of theme overrides having been added, and it
begs the question whether there'd perhaps be a readily available stock
theme that would be better suited than sphinx-rtd-theme?


BR,
Jani.


[1] https://www.kernel.org/doc/html/latest/



>
>> [1]: https://lkml.kernel.org/r/550fe790-b18d-f882-4c70-477b596facc7@gmail.com
>> 
>> I think there should be some knobs for customizing the styles.
>> But I don't know much about css.
>> 
>> Can anybody restore the current look of kernel-doc HTML pages
>> in a sphinx-rtd-theme-1.0.0-compatible way?
>> 
>> Sidenote:
>> 
>> The change (html_css_files) actually works with
>>     - Sphinx 1.7.9 + sphinx-rtd-theme 1.0.0
>> 
>> This contradicts the Sphinx documentation saying that html_css_files
>> was new to Sphinx 1.8.  This might be related to the changes in
>> sphinx-rtd-theme side, but I have no evidence.
>> 
>> Any suggestion is welcome!
>
> thanks.

-- 
Jani Nikula, Intel Open Source Graphics Center

  reply	other threads:[~2021-11-26 22:05 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-26 10:50 Mauro Carvalho Chehab
2021-11-26 11:06 ` Hans Verkuil
2021-11-26 13:06 ` Laurent Pinchart
2021-11-26 14:33 ` Akira Yokosawa
2021-11-26 19:37   ` Randy Dunlap
2021-11-26 22:03     ` Jani Nikula [this message]
2021-11-27  9:25       ` Mauro Carvalho Chehab
2021-11-27 15:59         ` Randy Dunlap
2021-12-01 10:16           ` Mauro Carvalho Chehab
2021-11-29 21:36       ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87sfvik21z.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=hverkuil@xs4all.nl \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=rdunlap@infradead.org \
    --subject='Re: [PATCH] docs: conf.py: fix support for Readthedocs v 1.0.0' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).