Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sphinx-design is a Sphinx extension for designing beautiful, view size responsiv
- Responsive design inspired by [Bootstrap](https://getbootstrap.com/) (v5), [Material Design](https://material.io), and [Material-UI](https://material-ui.com/)
- Support for both reStructuredText and [MyST Markdown](https://myst-parser.readthedocs.io/) (via integration with myst-parser)

The extension works with multiple Sphinx themes including alabaster, sphinx-rtd-theme, pydata-sphinx-theme, sphinx-book-theme, furo, and sphinx-immaterial.
The extension works with multiple Sphinx themes including alabaster, sphinx-rtd-theme, pydata-sphinx-theme, sphinx-book-theme, furo, sphinx-immaterial, and shibuya.

## Repository Structure

Expand Down Expand Up @@ -103,6 +103,7 @@ tox -e docs-pydata
tox -e docs-sbt
tox -e docs-furo
tox -e docs-im
tox -e docs-shibuya

# Clean build (set CLEAN env var)
CLEAN=1 tox -e docs-furo
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ View the documentation in multiple themes:
- [pydata-sphinx-theme](https://sphinx-design.readthedocs.io/en/pydata-theme)
- [sphinx-rtd-theme](https://sphinx-design.readthedocs.io/en/rtd-theme)
- [furo](https://sphinx-design.readthedocs.io/en/furo-theme)
- [shibuya](https://sphinx-design.readthedocs.io/en/shibuya-theme)

## Comparison to sphinx-panels

Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@
},
],
}
if html_theme == "shibuya":
html_theme_options = {
"accent_color": "orange",
"github_url": "https://github.com/executablebooks/sphinx-design",
}

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
myst_enable_extensions = [
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ sphinx-book-theme <https://sphinx-design.readthedocs.io/en/sbt-theme>
pydata-sphinx-theme <https://sphinx-design.readthedocs.io/en/pydata-theme>
sphinx-rtd-theme <https://sphinx-design.readthedocs.io/en/rtd-theme>
furo <https://sphinx-design.readthedocs.io/en/furo-theme>
shibuya <https://sphinx-design.readthedocs.io/en/shibuya-theme>
```


Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ theme-pydata = ["pydata-sphinx-theme~=0.20.0"]
theme-rtd = ["sphinx-rtd-theme~=3.1"]
theme-sbt = ["sphinx-book-theme~=1.2"]
theme-im = ["sphinx-immaterial~=0.13.9"]
theme-shibuya = ["shibuya~=2026.7.12"]

[dependency-groups]
# keep in sync with the mirrors-mypy / ruff-pre-commit revs in .pre-commit-config.yaml
Expand Down
4 changes: 3 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ passenv =
SD_CSS_EQUIV_BASE
commands = pytest {posargs}

[testenv:docs-{alabaster,rtd,pydata,sbt,furo,im}]
[testenv:docs-{alabaster,rtd,pydata,sbt,furo,im,shibuya}]
description =
Run documentation build for this theme
extras =
Expand All @@ -34,6 +34,7 @@ extras =
sbt: theme_sbt
furo: theme_furo
im: theme_im
shibuya: theme_shibuya
allowlist_externals = echo
passenv =
BUILDER
Expand All @@ -46,6 +47,7 @@ setenv =
sbt: SPHINX_THEME = sphinx_book_theme
furo: SPHINX_THEME = furo
im: SPHINX_THEME = sphinx_immaterial
shibuya: SPHINX_THEME = shibuya
commands_pre =
python -c "import shutil; shutil.rmtree('docs/_build/{env:BUILDER:html}/{env:SPHINX_THEME:}', ignore_errors=True) if '{env:CLEAN:}' else None"
commands =
Expand Down