linux-kernel - Re: [PATCH 1/2] docs: Document how to use the recommended docs theme

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: <02a91f3a-c83b-4c1a-a07f-cdd0b82cc199@infradead.org>
Date: Tue, 20 May 2025 09:14:19 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Nicolas Frattaroli <nicolas.frattaroli@...labora.com>,
 Jonathan Corbet <corbet@....net>
Cc: kernel@...labora.com, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/2] docs: Document how to use the recommended docs theme

Hi,

On 5/20/25 8:57 AM, Nicolas Frattaroli wrote:
> The current documentation on writing documentation documents that the
> RTD theme should be used. It goes on to explain how to install it
> through pip, but fails to mention how to use it. While the DOCS_THEME
> Makeflag is mentioned later on, it's not clear that the pypi package
> name of the RTD theme happens to also be the theme's name.
> 
> With web search engines approaching a critical mass of uselessness this
> decade, let's explicitly mention how to make use of the recommended
> theme, in order to save people some effort.
> 
> Signed-off-by: Nicolas Frattaroli <nicolas.frattaroli@...labora.com>
> ---
>  Documentation/doc-guide/sphinx.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 8081ebfe48bc045ff4e86001d3eba884b338bf32..029c350dc12803b53d0c3193acc0cdc5a6777de6 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -46,7 +46,8 @@ or ``virtualenv``, depending on how your distribution packaged Python 3.
>  
>     #) It is recommended to use the RTD theme for html output. Depending
>        on the Sphinx version, it should be installed separately,
> -      with ``pip install sphinx_rtd_theme``.
> +      with ``pip install sphinx_rtd_theme``. You can then pass
> +      ``DOCS_THEME=sphinx_rtd_theme`` in your Makeflags to use it.

In https://lore.kernel.org/linux-doc/20250519223613.37277-1-rdunlap@infradead.org/
(just posted yesterday, not merged anywhere), I moved that "note" to just after the
mention of the DOCS_THEME environment variable.
Maybe that will be sufficient?

Thanks.

>  
>  In summary, if you want to install the latest version of Sphinx, you
>  should do::
> 

-- 
~Randy