Re: [PATCH 2/2] docs: address some text issues with css/theme support

From: Randy Dunlap
Date: Sat Dec 11 2021 - 12:13:10 EST




On 12/11/21 00:57, Mauro Carvalho Chehab wrote:
> Fix:
> - overriden ->overridden
> - some whitespace issues introduced at the css/theme
> Makefile help.
>
> Reported-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
>
> See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1639212812.git.mchehab+huawei@xxxxxxxxxx/
>
> Documentation/Makefile | 4 ++--
> Documentation/doc-guide/sphinx.rst | 2 +-
> 2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index c9543b63dc6a..9f4bd42cef18 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -159,8 +159,8 @@ dochelp:
> @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
> @echo ' configuration. This is e.g. useful to build with nit-picking config.'
> @echo
> - @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
> + @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.'
> + @echo ' make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
> @echo
> @echo ' Default location for the generated documents is Documentation/output'
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 7fb6e6168bbb..673cbb769c08 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -147,7 +147,7 @@ By default, the build will try to use the Read the Docs sphinx theme:
>
> If the theme is not available, it will fall-back to the classic one.
>
> -The Sphinx theme can be overriden by using the ``DOCS_THEME`` make variable.
> +The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
>
> To remove the generated documentation, run ``make cleandocs``.
>
>

--
~Randy