Re: [PATCH v3 1/4] docs: allow selecting a Sphinx theme

From: Jonathan Corbet
Date: Mon Dec 06 2021 - 14:12:17 EST


Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> writes:

> Instead of having RTD as an almost mandatory theme, allow the
> user to select other themes via a THEMES 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@xxxxxxxxxx>
> ---
>
> See [PATCH v3 0/4] at: https://lore.kernel.org/all/cover.1638369365.git.mchehab+huawei@xxxxxxxxxx/
>
> Documentation/Makefile | 3 ++
> Documentation/conf.py | 52 +++++++++++++++++-------------
> Documentation/doc-guide/sphinx.rst | 8 +++++
> 3 files changed, 41 insertions(+), 22 deletions(-)

So I'm playing with this now, and definitely want to apply it. I do
have one little worry, though... THEME seems like an overly general
name to use here, and seems relatively likely to conflict with other
uses. THEME= on the command line is fine, but what do you think about
something like DOCS_THEME for the environment variable? Or even
HTML_THEME as Sphinx uses?

Thanks,

jon