Skip to content

Commit

Permalink
docs: address some text issues with css/theme support
Browse files Browse the repository at this point in the history
Fix:
- overriden ->overridden
- some whitespace issues introduced at the css/theme
  Makefile help.

Reported-by: Randy Dunlap <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Link: https://lore.kernel.org/r/b0b166025019f7cc4f122bd789c79ba28cc2d29d.1639212812.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Dec 16, 2021
1 parent 98d614b commit 0e805b1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions Documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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'
2 changes: 1 addition & 1 deletion Documentation/doc-guide/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.

Expand Down

0 comments on commit 0e805b1

Please sign in to comment.