linux-kernel - Re: [PATCH v4 1/4] docs: allow selecting a Sphinx 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 for Android: free password hash cracker in your pocket

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

Message-ID: <936d6140-72bb-fe49-9013-638cb087f1a2@infradead.org>
Date:   Fri, 10 Dec 2021 20:24:33 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Akira Yokosawa <akiyks@...il.com>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Nícolas F. R. A. Prado 
        <nfraprado@...tonmail.com>, Alex Shi <alexs@...nel.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 1/4] docs: allow selecting a Sphinx theme

Hi,

On 12/7/21 01:52, Mauro Carvalho Chehab wrote:
> Instead of having RTD as an almost mandatory theme, allow the
> user to select other themes via DOCS_THEME environment var.
> 
> There's a catch, though: as the current theme override logic is
> dependent of the RTD theme, we need to move the code which
> adds the CSS overrides to be inside the RTD theme logic.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
> 
> See [PATCH v4 0/4] at: https://lore.kernel.org/all/cover.1638870323.git.mchehab+huawei@kernel.org/
> 
>  Documentation/Makefile             |  3 ++
>  Documentation/conf.py              | 52 +++++++++++++++++-------------
>  Documentation/doc-guide/sphinx.rst |  8 +++++
>  3 files changed, 41 insertions(+), 22 deletions(-)
> 

> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index e445cb146efe..bef276c58ebe 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -138,6 +138,14 @@ To pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make
>  variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose
>  output.
>  
> +By default, the build will try to use the Read the Docs sphinx theme:
> +
> +    https://github.com/readthedocs/sphinx_rtd_theme
> +
> +If the theme is not available, it will fall-back to the classic one.
> +
> +The Sphinx theme can be overriden by using the ``DOCS_THEME`` make variable.

                           overridden

> +
>  To remove the generated documentation, run ``make cleandocs``.
>  
>  Writing Documentation
> 

-- 
~Randy