From dbd1b1dfe578a193923c6b93c8fc8d957fe3ec19 Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Fri, 3 Feb 2023 12:01:12 -0300 Subject: [PATCH] tools: rename sphinx-build and rundocs Rename them to docs-build and docs-autobuild (respectively). This is to keep consistent with the other tox environments, which use the - prefix grouping. --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 2eab382012..7b67e8ae62 100644 --- a/tox.ini +++ b/tox.ini @@ -119,7 +119,7 @@ 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 @@ -127,7 +127,7 @@ commands_pre = bash -c 'if [[ ! -e docs ]];then echo "No docs directory. Run `to # "-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