From 315757e698076e486dd7b4b7c98b16e33f399977 Mon Sep 17 00:00:00 2001 From: Thomas Atkins Date: Tue, 16 Dec 2025 15:17:12 -0800 Subject: [PATCH 1/2] Change The Doc theme to Furo --- docs/conf.py | 13 ++++--------- docs/requirements.txt | 1 + pyproject.toml | 14 ++++++++------ 3 files changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 92f1b41f..642553b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 ------------------------------------------------- @@ -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"] diff --git a/docs/requirements.txt b/docs/requirements.txt index 0109decf..906e596b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 82a20e06..06752380 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" @@ -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.*"] From e8bf378f50668ca2dea07fc1ba4ebf789466b2eb Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 23:22:51 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 642553b8..e593a3a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,7 +45,7 @@ html_theme_options = { "source_repository": "https://github.com/llnl/Surfactant", "source_branch": "main", - "source_directory": "docs/" + "source_directory": "docs/", } # -- Extension configuration -------------------------------------------------