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>,
"Akira Yokosawa" <akiyks@gmail.com>,
"Jani Nikula" <jani.nikula@linux.intel.com>,
"Nícolas F. R. A. Prado" <nfraprado@protonmail.com>,
"Randy Dunlap" <rdunlap@infradead.org>,
"Alex Shi" <alexs@kernel.org>,
"Andrew Klychkov" <andrew.a.klychkov@gmail.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH v3 2/4] docs: allow to pass extra CSS themes via make
Date: Wed, 1 Dec 2021 18:59:06 +0100 [thread overview]
Message-ID: <77038995f9cc3205bc1c694ef71848a83d979744.1638369365.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1638369365.git.mchehab+huawei@kernel.org>
Specially when the RTD theme is not used, it makes sense to
allow specifying extra CSS files via a make variable.
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 | 8 +++++++-
Documentation/conf.py | 7 +++++++
Documentation/doc-guide/sphinx.rst | 3 +++
3 files changed, 17 insertions(+), 1 deletion(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index d4039d77b32a..b3ccd1925cd3 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -20,6 +20,7 @@ SPHINXBUILD = sphinx-build
SPHINXOPTS =
SPHINXDIRS = .
THEME =
+CSS =
_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
SPHINX_CONF = conf.py
PAPER =
@@ -85,7 +86,10 @@ quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
-D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
$(ALLSPHINXOPTS) \
$(abspath $(srctree)/$(src)/$5) \
- $(abspath $(BUILDDIR)/$3/$4)
+ $(abspath $(BUILDDIR)/$3/$4) && \
+ if [ "x$(CSS)" != "x" ]; then \
+ cp $(CSS) $(BUILDDIR)/$3/_static/; \
+ fi
htmldocs:
@$(srctree)/scripts/sphinx-pre-install --version-check
@@ -157,4 +161,6 @@ dochelp:
@echo
@echo ' make THEME={sphinx-theme} selects a different Sphinx theme.'
@echo
+ @echo ' make CSS={a .css file} adds a CSS override file for html/epub output.'
+ @echo
@echo ' Default location for the generated documents is Documentation/output'
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 082c3ac9dd33..0e2593e4d357 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -210,6 +210,7 @@ highlight_language = 'none'
# Default theme
html_theme = 'sphinx_rtd_theme'
+html_css_files = []
if "THEME" in os.environ:
html_theme = os.environ["THEME"]
@@ -229,6 +230,12 @@ if html_theme == 'sphinx_rtd_theme':
except ImportError:
html_theme = 'classic'
+if "CSS" in os.environ:
+ css = os.environ["CSS"].split(" ")
+
+ for l in css:
+ html_css_files.append(l)
+
if major <= 1 and minor < 8:
html_context = {
'css_files': [],
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 33a527f5ae64..e25bc033aad3 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -138,6 +138,9 @@ 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.
+It is also possible to pass an extra CSS overlay file, in order to customize
+the html layout, by using the ``CSS`` make variable.
+
By default, the build will try to use the Read the Docs sphinx theme:
https://github.com/readthedocs/sphinx_rtd_theme
--
2.33.1
next prev parent 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 [PATCH v3 0/4] docs: add better support for Sphinx themes and CSS Mauro Carvalho Chehab
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 ` Mauro Carvalho Chehab [this message]
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=77038995f9cc3205bc1c694ef71848a83d979744.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=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.