Skip to content

Commit

Permalink
tools: rename sphinx-build and rundocs
Browse files Browse the repository at this point in the history
Rename them to docs-build and docs-autobuild (respectively). This is to
keep consistent with the other tox environments, which use the
<category>- prefix grouping.
  • Loading branch information
tigarmo authored and sergiusens committed Feb 3, 2023
1 parent 34e0222 commit dbd1b1d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,15 @@ no_package = true
env_dir = {work_dir}/docs
runner = ignore_env_name_mismatch

[testenv:sphinx-build]
[testenv:docs-build]
description = Build sphinx documentation
base = docs
allowlist_externals = bash
commands_pre = bash -c 'if [[ ! -e docs ]];then echo "No docs directory. Run `tox run -e sphinx-quickstart` to create one.;";return 1;fi'
# "-W" is to treat warnings as errors
commands = sphinx-build {posargs:-b html} -W {tox_root}/docs {tox_root}/docs/_build

[testenv:rundocs]
[testenv:docs-autobuild]
description = Build documentation with an autoupdating server
base = docs
commands = sphinx-autobuild {posargs:-b html --open-browser --port 8080} -W --watch {tox_root}/starcraft {tox_root}/docs {tox_root}/docs/_build
Expand Down

0 comments on commit dbd1b1d

Please sign in to comment.