Skip to content

Modernise SKC docs theme #1978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2025
Merged

Modernise SKC docs theme #1978

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7401cf5
Modernise SKC docs theme
stackhpc-ci Nov 11, 2025
12c0c3f
Add dark mode to docs
stackhpc-ci Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ sphinx-copybutton # MIT
sphinx-substitution-extensions # MIT
sphinx>=4.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
sphinx-immaterial # MIT
13 changes: 11 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx_immaterial',
'reno.sphinxext',
#'sphinx.ext.autodoc',
'sphinx.ext.extlinks',
Expand Down Expand Up @@ -89,15 +90,23 @@
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = []
html_theme = 'default'
html_theme = 'sphinx_immaterial'
# html_static_path = ['static']

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

html_theme_options = {
# "show_other_versions": True,
"features": [
"navigation.expand",
"navigation.top",
"navigation.footer",
"search.suggest",
"content.code.copy",
"toc.follow",
"toc.sticky",
]
}

# Output file base name for HTML help builder.
Expand Down
Loading