Skip to content

Change The Doc theme to Furo #561

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
nightlark merged 2 commits into from
Dec 17, 2025
Merged

Change The Doc theme to Furo #561

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
315757e
Change The Doc theme to Furo
Nova38 Dec 16, 2025
e8bf378
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 16, 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
13 changes: 4 additions & 9 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,11 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_theme = "furo"
html_theme_options = {
"description": "Surfactant",
"github_user": "LLNL",
"github_repo": "Surfactant",
"github_button": "true",
"github_banner": "true",
"badge_branch": "main",
"fixed_sidebar": "false",
"source_repository": "https://github.com/llnl/Surfactant",
"source_branch": "main",
"source_directory": "docs/",
}

# -- Extension configuration -------------------------------------------------
Expand All @@ -59,7 +55,6 @@
napoleon_numpy_docstring = True
html_logo = "./logos/surfactant-logo-light.png"
html_favicon = html_logo
html_sidebars = {"**": ["globaltoc.html", "relations.html", "searchbox.html"]}
html_static_path = ["_static"]


Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ requests==2.32.5
#breathe==4.31.0
#sphinxcontrib-svg2pdfconverter==1.1.1
#sphinxcontrib-mermaid==0.8.1
furo>=2025.9.25
14 changes: 8 additions & 6 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,20 @@ dependencies = [
"python-msi==0.0.0a3",
# Pinned to specific version for potential breaking changes
"rpmfile==2.1.0",
]
]
dynamic = ["version"]

[dependency-groups]
test = ["pytest"]
dev = ["build", "pre-commit"]
docs = ["sphinx", "myst-parser", "furo>=2025.9.25"]

[project.optional-dependencies]
macho = ["lief==0.17.1"]
java = ["javatools>=1.6,==1.*"]
test = ["pytest", "pytest-asyncio"]
dev = ["build", "pre-commit"]
docs = ["sphinx", "myst-parser"]
docs = ["sphinx", "myst-parser", "furo>=2025.9.25"]

[project.scripts]
surfactant = "surfactant.__main__:main"
Expand All @@ -83,10 +88,7 @@ Documentation = "https://surfactant.readthedocs.io/en/latest/"
"Issue Tracker" = "https://github.com/LLNL/Surfactant/issues"
"Source Code" = "https://github.com/LLNL/Surfactant"

[dependency-groups]
test = ["pytest"]
dev = ["build", "pre-commit"]
docs = ["sphinx", "myst-parser"]


[tool.setuptools.packages.find]
include = ["surfactant", "surfactant.*"]
Expand Down