Skip to content

Commit

Permalink
docs: Live reload with sphinx-autobuild (#1323)
Browse files Browse the repository at this point in the history
- [x] it works πŸŽ‰ 
- [x] sphinx-autobuild was already included in pyproject.toml, was there
already a way to rebuild on change?
- [x] let's paint that bike shed and decide on the `tox -e <name>` for
this
  • Loading branch information
dimaqq committed Aug 29, 2024
1 parent 8bc7ad8 commit 79e89df
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ commands_pre =
commands =
sphinx-build -W --keep-going docs/ docs/_build/html

[testenv:docs-live]
description = Live development: build the Sphinx docs with autoreloading enabled
deps = {[testenv:docs]deps}
commands_pre =
{[testenv:docs]commands_pre}
# https://github.com/sphinx-doc/sphinx-autobuild/issues/170
change_dir = {tox_root}/docs
commands =
sphinx-autobuild ./ ./_build/html --watch . --port 8000

[testenv:fmt]
description = Apply coding style standards to code
deps =
Expand Down

0 comments on commit 79e89df

Please sign in to comment.