Skip to content

Commit 5bcf052

Browse files
stackhpc-ciAlex-Welsh
authored andcommitted
Modernise SKC docs theme
1 parent 1bbb90b commit 5bcf052

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

doc/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ sphinx-copybutton # MIT
33
sphinx-substitution-extensions # MIT
44
sphinx>=4.2.0 # BSD
55
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
6+
sphinx-immaterial # MIT

doc/source/conf.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
# Add any Sphinx extension module names here, as strings. They can be
5353
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
5454
extensions = [
55+
'sphinx_immaterial',
5556
'reno.sphinxext',
5657
#'sphinx.ext.autodoc',
5758
'sphinx.ext.extlinks',
@@ -89,15 +90,23 @@
8990
# The theme to use for HTML and HTML Help pages. Major themes that come with
9091
# Sphinx are currently 'default' and 'sphinxdoc'.
9192
# html_theme_path = []
92-
html_theme = 'default'
93+
html_theme = 'sphinx_immaterial'
9394
# html_static_path = ['static']
9495

9596
# Add any paths that contain "extra" files, such as .htaccess or
9697
# robots.txt.
9798
# html_extra_path = ['_extra']
9899

99100
html_theme_options = {
100-
# "show_other_versions": True,
101+
"features": [
102+
"navigation.expand",
103+
"navigation.top",
104+
"navigation.footer",
105+
"search.suggest",
106+
"content.code.copy",
107+
"toc.follow",
108+
"toc.sticky",
109+
]
101110
}
102111

103112
# Output file base name for HTML help builder.

0 commit comments

Comments
 (0)