starlingx/docs
Code Issues Proposed changes

Upver tox and sphinx (r9, r8, r7, r6, r5)

Browse Source 
Bump to tox 4, docultils 18.1 and sphinx 7

Change-Id: I8664bbd473b84be0b8c90db16ecd280bb9f8b077
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-04-30 16:20:32 +00:00
parent 7d6847d59a
commit 0666ef783b
3 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.zuul.yaml
View File

@ -1,7 +1,8 @@
--- ---
- project: - project:
vars: vars:
ensure_tox_version: '<4' # ensure_tox_version: '<4'
ensure_tox_version: '>=4.14.2'
templates: templates:
- stx-api-ref-jobs - stx-api-ref-jobs
check: check:

4
doc/requirements.txt
View File

@ -1,7 +1,7 @@
#sphinx==4.2.0 #sphinx==4.2.0
sphinx==5.0 sphinx==7.0
openstackdocstheme>=2.2.1,<=2.3.1 # Apache-2.0 openstackdocstheme>=2.2.1,<=2.3.1 # Apache-2.0
docutils==0.17.1 docutils==0.18.1
PyYAML==6.0 PyYAML==6.0
sphinx-tabs<=3.4.1 sphinx-tabs<=3.4.1

25
tox.ini
View File

@ -9,6 +9,7 @@ setenv = VIRTUAL_ENV={envdir}
OS_STDOUT_CAPTURE=1 OS_STDOUT_CAPTURE=1
OS_STDERR_CAPTURE=1 OS_STDERR_CAPTURE=1
OS_TEST_TIMEOUT=60 OS_TEST_TIMEOUT=60
LC_ALL=C
deps = -r{toxinidir}/test-requirements.txt deps = -r{toxinidir}/test-requirements.txt
[testenv:prebuild-docs] [testenv:prebuild-docs]
@ -40,10 +41,10 @@ commands =
sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -t virtual -b html doc/source doc/build/html {posargs} sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -t virtual -b html doc/source doc/build/html {posargs}
{[testenv:postbuild-docs]commands} {[testenv:postbuild-docs]commands}
# Note: The dev env for the docs team uses a version of tox that does not yet support allowlist_externals # Note: The dev env for the docs team uses a version of tox that does not yet support allowlist_externals
whitelist_externals = bash allowlist_externals = bash
hide-empty-rows.sh ./hide-empty-rows.sh
htmlChecks.sh ./htmlChecks.sh
get-remote-files.sh ./get-remote-files.sh
git git
# hw-updates.sh # hw-updates.sh
@ -55,10 +56,10 @@ commands =
{[testenv:prebuild-docs]commands} {[testenv:prebuild-docs]commands}
sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b singlehtml doc/source doc/build/singlepage {posargs} sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b singlehtml doc/source doc/build/singlepage {posargs}
{[testenv:postbuild-docs]commands} {[testenv:postbuild-docs]commands}
whitelist_externals = bash allowlist_externals = bash
hide-empty-rows.sh ./hide-empty-rows.sh
htmlChecks.sh ./htmlChecks.sh
get-remote-files.sh ./get-remote-files.sh
git git
[testenv:api-ref] [testenv:api-ref]
@ -66,10 +67,10 @@ deps = {[testenv:docs]deps}
commands = commands =
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
whitelist_externals = rm allowlist_externals = rm
[testenv:linters] [testenv:linters]
whitelist_externals = bash allowlist_externals = bash
commands = commands =
bash -c "find {toxinidir} \ bash -c "find {toxinidir} \
\( -name .tox -prune \) \ \( -name .tox -prune \) \
@ -87,13 +88,13 @@ passenv=PWD
commands = commands =
bash -c "echo Running in {env:PWD}" bash -c "echo Running in {env:PWD}"
bash new-topic.sh {env:PWD} {toxinidir} bash new-topic.sh {env:PWD} {toxinidir}
whitelist_externals = new-topic.sh allowlist_externals = ./new-topic.sh
bash bash
[testenv:picks] [testenv:picks]
commands = commands =
./pickCompare.sh ./pickCompare.sh
whitelist_externals = pickCompare.sh allowlist_externals = ./pickCompare.sh
bash bash