lkml.org 
[lkml]   [2021]   [Dec]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 1/4] docs: allow selecting a Sphinx theme
Em Mon, 06 Dec 2021 12:12:12 -0700
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> 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@kernel.org>
> > ---
> >
> > See [PATCH v3 0/4] at: https://lore.kernel.org/all/cover.1638369365.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(-)
>
> 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?

I'm not sure if we will ever consider a "THEME" environment var for anything
but docs and html stuff. That's why I ended taking the shortest name (for
both THEME and CSS make vars).

Yet, I'm OK if to use whatever name you think it would work best.

Btw, while I didn't actually test, maybe those would also apply to epub,
so, just in case, I guess DOCS_THEME would be preferable, IMO.

Thanks,
Mauro

\
 
 \ /
  Last update: 2021-12-06 21:15    [W:0.109 / U:0.244 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site