Skip to content

Docs theme 2023.1 #1981

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

Closed
wants to merge 2 commits into from
+31 −2
Closed

Docs theme 2023.1 #1981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1532568
Modernise SKC docs theme
stackhpc-ci Nov 11, 2025
9de8641
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 @@ -6,3 +6,4 @@ reno>=3.4.0 # Apache-2.0
sphinx>=4.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
Sphinx-Substitution-Extensions # Apache-2.0
sphinx-immaterial # MIT
Copy link

@gemini-code-assist gemini-code-assist bot Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure reproducible documentation builds and prevent unexpected breakages from future updates, it's a good practice to pin the version of this dependency. You could specify a minimum version or an exact version. For example, sphinx-immaterial>=0.11.1.

sphinx-immaterial>=0.11.1 # MIT

32 changes: 30 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 @@ -88,15 +89,42 @@
# 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,
"palette": [

{
"media": "(prefers-color-scheme: light)",
"scheme": "default",
"toggle": {
"icon": "material/weather-sunny",
"name": "Switch to dark mode",
}
},
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"toggle": {
"icon": "material/weather-night",
"name": "Switch to system preference",
}
},
],
"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