All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: "Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org,
	"Jani Nikula" <jani.nikula@linux.intel.com>,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Akira Yokosawa" <akiyks@gmail.com>,
	"Nícolas F. R. A. Prado" <nfraprado@protonmail.com>,
	"Alex Shi" <alexs@kernel.org>,
	"Andrew Klychkov" <andrew.a.klychkov@gmail.com>,
	"Miguel Ojeda" <ojeda@kernel.org>
Subject: [PATCH v3 0/4] docs: add better support for Sphinx themes and CSS
Date: Wed,  1 Dec 2021 18:59:04 +0100	[thread overview]
Message-ID: <cover.1638369365.git.mchehab+huawei@kernel.org> (raw)

Hi Jon,

This series comes after my patch fixing Sphinx support for RTD 1.0.0:

   https://lore.kernel.org/lkml/80009f0d17ea0840d81e7e16fff6e7677919fdfc.1638004294.git.mchehab+huawei@kernel.org/

It provides, IMHO, a nice improvement on themes selection. This series
is a v2 of the other theme-related patches I sent today.

-

Sphinx allows using different output templates for HTML (and e-pub).

Right now, the Kernel was hardcoded to use the Read the Docs theme,
falling back to whatever default is setup on a given Sphinx version.

Well, themes and templates are actually an user preference.

This patch set allows selecting different themes and even provide
extra CSS override files.

With that, one could, for instance, do things like:

$ echo "body { color: darkgreen; } div.body { color: darkgreen; } " >my_css.css && make SPHINXDIRS=input CSS=my_css.css THEME=nature htmldocs

In order to use the Sphinx nature theme with the normal font in green.

patch 1 adds a theme selection make variable (THEME);
patch 2 adds a css selection variable (CSS);
patch 3 sets the classic theme to look a little better;
patch 4 adds support for the RTD dark mode theme.

It should be noticed that the RTD dark mode currently has some issues,
as it is actually an override on the top of the original RTD theme.
I suspect it needs to be updated to properly support Sphinx 4.3.0 and
RTD 1.0.0 theme. Yet, it seems useful, as one can always switch to daylight
mode in runtime, if something looks odd with it enabled.

---

v3:
   - Fixed an issue at the logic which copies the extra CSS files on patch 2.

Mauro Carvalho Chehab (4):
  docs: allow selecting a Sphinx theme
  docs: allow to pass extra CSS themes via make
  docs: set format for the classic mode
  docs: add support for RTD dark mode

 Documentation/Makefile                        |  11 +-
 Documentation/conf.py                         | 102 ++++++++++++++----
 Documentation/doc-guide/sphinx.rst            |  11 ++
 .../sphinx-static/theme_overrides.css         |  16 +--
 .../sphinx-static/theme_rtd_colors.css        |  37 +++++++
 5 files changed, 140 insertions(+), 37 deletions(-)
 create mode 100644 Documentation/sphinx-static/theme_rtd_colors.css

-- 
2.33.1



             reply	other threads:[~2021-12-01 17:59 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-01 17:59 Mauro Carvalho Chehab [this message]
2021-12-01 17:59 ` [PATCH v3 1/4] docs: allow selecting a Sphinx theme Mauro Carvalho Chehab
2021-12-02 11:24   ` Miguel Ojeda
2021-12-02 11:47     ` Mauro Carvalho Chehab
2021-12-02 11:50       ` Miguel Ojeda
2021-12-03 14:08       ` Mauro Carvalho Chehab
2021-12-06 19:12   ` Jonathan Corbet
2021-12-06 20:14     ` Mauro Carvalho Chehab
2021-12-06 22:55       ` Jonathan Corbet
2021-12-07  9:16         ` Mauro Carvalho Chehab
2021-12-07  9:20           ` Mauro Carvalho Chehab
2021-12-01 17:59 ` [PATCH v3 2/4] docs: allow to pass extra CSS themes via make Mauro Carvalho Chehab
2021-12-01 17:59 ` [PATCH v3 3/4] docs: set format for the classic mode Mauro Carvalho Chehab
2021-12-01 17:59 ` [PATCH v3 4/4] docs: add support for RTD dark mode Mauro Carvalho Chehab

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=cover.1638369365.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=alexs@kernel.org \
    --cc=andrew.a.klychkov@gmail.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nfraprado@protonmail.com \
    --cc=ojeda@kernel.org \
    --cc=rdunlap@infradead.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.