Skip to content

Commit

Permalink
📚 Update theme versions (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell authored May 18, 2024
1 parent fe583c5 commit 9412892
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 43 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ horizontal card (grid row inside card, picture on left)

subtitle for card (see <https://material.io/components/cards#anatomy>)

rtd PRs not working


[github-ci]: https://github.com/executablebooks/sphinx-design/workflows/continuous-integration/badge.svg?branch=main
[github-link]: https://github.com/executablebooks/sphinx-design
Expand Down
9 changes: 5 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,11 @@ testing = [
"pytest-regressions",
"defusedxml",
]
theme-furo = ["furo~=2023.7.0"]
theme-pydata = ["pydata-sphinx-theme~=0.13.0"]
theme-rtd = ["sphinx-rtd-theme~=1.0"]
theme-sbt = ["sphinx-book-theme~=1.0"]

theme-furo = ["furo~=2024.5.4"]
theme-pydata = ["pydata-sphinx-theme~=0.15.2"]
theme-rtd = ["sphinx-rtd-theme~=2.0"]
theme-sbt = ["sphinx-book-theme~=1.1"]

[tool.flit.sdist]
exclude = [
Expand Down
48 changes: 11 additions & 37 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -15,54 +15,28 @@ extras =
testing
commands = pytest {posargs}

[testenv:docs-{update,clean}-{alabaster,rtd,pydata,sbt,furo}]
[testenv:docs-{alabaster,rtd,pydata,sbt,furo}]
description =
clean: Run documentation build for this theme (removing existing builds)
update: Run documentation build for this theme (reusing existing builds)
Run documentation build for this theme
extras =
rtd
rtd: theme_rtd
pydata: theme_pydata
sbt: theme_sbt
furo: theme_furo
allowlist_externals =
clean: rm
echo
allowlist_externals = echo
passenv =
BUILDER
CLEAN
TERM
setenv =
update: SKIP_APIDOC = true
alabaster: SPHINX_THEME = alabaster
rtd: SPHINX_THEME = sphinx_rtd_theme
pydata: SPHINX_THEME = pydata_sphinx_theme
sbt: SPHINX_THEME = sphinx_book_theme
furo: SPHINX_THEME = furo
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 =
clean: rm -rf docs/_build/{posargs:html}
sphinx-build -nW --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}
commands_post = echo "open docs/_build/{posargs:html}/index.html"

[testenv:docs-live-{alabaster,rtd,pydata,sbt,furo}]
description = Start documentation autobuild for this theme
extras =
rtd
rtd: theme_rtd
pydata: theme_pydata
sbt: theme_sbt
furo: theme_furo
deps =
pre-commit
sphinx-autobuild
setenv =
alabaster: SPHINX_THEME = alabaster
rtd: SPHINX_THEME = sphinx_rtd_theme
pydata: SPHINX_THEME = pydata_sphinx_theme
sbt: SPHINX_THEME = sphinx_book_theme
furo: SPHINX_THEME = furo
commands =
sphinx-autobuild \
--watch sphinx_design \
--watch style \
--pre-build "npm run css" \
--re-ignore sphinx_design/compiled/.* \
--re-ignore docs/_build/.* \
--port 0 --open-browser \
-n -b {posargs:html} docs/ docs/_build/{posargs:html}
sphinx-build -nW --keep-going {posargs} -b {env:BUILDER:html} docs/ docs/_build/{env:BUILDER:html}/{env:SPHINX_THEME:}
commands_post = echo "open docs/_build//{env:BUILDER:html}/{env:SPHINX_THEME:}/index.html"

0 comments on commit 9412892

Please sign in to comment.