lkml.org 
[lkml]   [2021]   [Dec]   [10]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v4 2/4] docs: allow to pass extra DOCS_CSS themes via make
Hi--

On 12/7/21 01:53, Mauro Carvalho Chehab wrote:
> 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 v4 0/4] at: https://lore.kernel.org/all/cover.1638870323.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 11f8b3b9a7ef..9f0f53db2f10 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -20,6 +20,7 @@ SPHINXBUILD = sphinx-build
> SPHINXOPTS =
> SPHINXDIRS = .
> DOCS_THEME =
> +DOCS_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$(DOCS_CSS)" != "x" ]; then \
> + cp $(DOCS_CSS) $(BUILDDIR)/$3/_static/; \
> + fi
>
> htmldocs:
> @$(srctree)/scripts/sphinx-pre-install --version-check
> @@ -157,4 +161,6 @@ dochelp:
> @echo
> @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
> @echo
> + @echo ' make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'

The 2 new ' make DOCS_THEME/DOCS_CSS' lines are indented one more space than the
preceding ' make SPHINX*' lines.

> + @echo
> @echo ' Default location for the generated documents is Documentation/output'


--
~Randy

\
 
 \ /
  Last update: 2021-12-11 05:25    [W:0.064 / U:0.160 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site