Skip to content

Commit

Permalink
Run sphinx-autobuild via tox -e docs-live[-src]
Browse files Browse the repository at this point in the history
  • Loading branch information
rmartin16 committed Feb 16, 2024
1 parent 71cd314 commit b3be34a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
1 change: 1 addition & 0 deletions changes/2400.misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The ``sphinx-autobuild`` tool can now be invoked via ``tox -e docs-live`` and ``tox -e docs-live-src``.
19 changes: 9 additions & 10 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -42,28 +42,27 @@ build_dir = _build
# --keep-going: continue on errors
# -j: run with multiple processes
sphinx_args = -W --keep-going -j auto
# -v: verbose logging
# -E: force rebuild of environment
# -T: print traceback on error
# -a: read/parse all files
# -d: use tox's temp dir for caching
sphinx_args_extra = {[docs]sphinx_args} -v -E -T -a -d {envtmpdir}/doctrees
sphinx_args_extra = {[docs]sphinx_args} -E -T -d {envtmpdir}/doctrees

[testenv:docs{,-lint,-all}]
[testenv:docs{,-lint,-all,-live,-live-src}]
skip_install = True
change_dir = docs
deps =
./core[docs]
deps = ./core[docs]
passenv =
# On macOS M1, you need to manually set the location of the PyEnchant
# library:
# export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.2.dylib
PYENCHANT_LIBRARY_PATH
commands =
!lint-!all : python -m sphinx {[docs]sphinx_args} -b html . {[docs]build_dir}/html
lint : python -m sphinx {[docs]sphinx_args_extra} -b spelling . {[docs]build_dir}/spell
lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links
all : python -m sphinx {[docs]sphinx_args_extra} -b html . {[docs]build_dir}/html
!lint-!all-!live : python -m sphinx {[docs]sphinx_args} -b html . {[docs]build_dir}/html {posargs}
lint : python -m sphinx {[docs]sphinx_args_extra} -b spelling . {[docs]build_dir}/spell {posargs}
lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links {posargs}
all : python -m sphinx {[docs]sphinx_args_extra} -v -a -b html . {[docs]build_dir}/html {posargs}
live-!src : sphinx-autobuild {[docs]sphinx_args_extra} -b html . {[docs]build_dir}/live {posargs}
live-src : sphinx-autobuild {[docs]sphinx_args_extra} -a -b html . {[docs]build_dir}/live --watch ../core/src/toga/ {posargs}

[testenv:package]
skip_install = True
Expand Down

0 comments on commit b3be34a

Please sign in to comment.