Skip to content

Commit

Permalink
doc: sphinx: Load RTD theme as a Sphinx extension
Browse files Browse the repository at this point in the history
This commit loads the RTD theme as a Sphinx extension, which has the
benefit of going through said extension's "setup" method, effectively
setting useful settings such as default permalink icon (moving away from
the default, not so pretty, "¶").

Signed-off-by: Benjamin Cabé <[email protected]>
  • Loading branch information
kartben authored and fabiobaltieri committed Dec 6, 2023
1 parent d5c7761 commit aa1ca17
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
import textwrap

from sphinx.cmd.build import get_parser
import sphinx_rtd_theme


args = get_parser().parse_args()
ZEPHYR_BASE = Path(__file__).resolve().parents[1]
Expand Down Expand Up @@ -69,6 +67,7 @@

extensions = [
"breathe",
"sphinx_rtd_theme",
"sphinx.ext.todo",
"sphinx.ext.extlinks",
"sphinx.ext.autodoc",
Expand Down Expand Up @@ -136,7 +135,6 @@
# -- Options for HTML output ----------------------------------------------

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_options = {
"logo_only": True,
"prev_next_buttons_location": None
Expand Down

0 comments on commit aa1ca17

Please sign in to comment.