diff --git a/tox.ini b/tox.ini index 2d64950..f7d5347 100644 --- a/tox.ini +++ b/tox.ini @@ -24,7 +24,9 @@ commands = {posargs} # This env is invoked in the periodic pipeline and is therefore responsible to # build all relevant docs at once. [testenv:docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = + -r{toxinidir}/doc/requirements.txt + -c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints.txt allowlist_externals = mkdir cp @@ -36,13 +38,13 @@ commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html {[testenv:api-ref]commands} {[testenv:json-api-ref]commands} - {[testenv:best-practice]commands} - {[testenv:json-best-practice]commands} {[testenv:umn]commands} {[testenv:json-umn]commands} + {[testenv:best-practice]commands} + {[testenv:json-best-practice]commands} [testenv:docs-pdf] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = rm mkdir @@ -52,13 +54,13 @@ allowlist_externals = commands = mkdir -p doc/build/pdf {[testenv:api-ref-pdf-docs]commands} - {[testenv:best-practice-pdf-docs]commands} {[testenv:umn-pdf-docs]commands} + {[testenv:best-practice-pdf-docs]commands} # HTML version [testenv:api-ref] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -69,7 +71,7 @@ commands = # Json version (for search) [testenv:json-api-ref] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -84,7 +86,7 @@ commands = # PDF version [testenv:api-ref-pdf-docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = rm mkdir @@ -101,50 +103,9 @@ commands = cp api-ref/build/pdf/wafd-api-ref.pdf doc/build/pdf/ -# HTML version -[testenv:best-practice] -deps = -r{toxinidir}/doc/requirements.txt -allowlist_externals = - cp - mkdir -commands = - sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice - -# Json version (for search) -[testenv:json-best-practice] -deps = -r{toxinidir}/doc/requirements.txt -allowlist_externals = - cp - mkdir - sh -commands = - sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice - # Drop data useless for the search - wrap it also with sh/xargs due to bugs - # in tox - sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" - -# PDF version -[testenv:best-practice-pdf-docs] -deps = -r{toxinidir}/doc/requirements.txt -allowlist_externals = - rm - mkdir - make - bash - cp -commands = - rm -rf doc/best-practice/build/pdf - sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/ - bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true" - bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done" - make -C doc/best-practice/build/pdf - mkdir -p doc/build/pdf - cp doc/best-practice/build/pdf/wafd-best-practice.pdf doc/build/pdf/ - - # HTML version [testenv:umn] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -155,7 +116,7 @@ commands = # Json version (for search) [testenv:json-umn] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -170,7 +131,7 @@ commands = # PDF version [testenv:umn-pdf-docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = rm mkdir @@ -187,6 +148,47 @@ commands = cp umn/build/pdf/wafd-umn.pdf doc/build/pdf/ +# HTML version +[testenv:best-practice] +deps = {[testenv:docs]deps} +allowlist_externals = + cp + mkdir +commands = + sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice + +# Json version (for search) +[testenv:json-best-practice] +deps = {[testenv:docs]deps} +allowlist_externals = + cp + mkdir + sh +commands = + sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice + # Drop data useless for the search - wrap it also with sh/xargs due to bugs + # in tox + sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" + +# PDF version +[testenv:best-practice-pdf-docs] +deps = {[testenv:docs]deps} +allowlist_externals = + rm + mkdir + make + bash + cp +commands = + rm -rf doc/best-practice/build/pdf + sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/ + bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true" + bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done" + make -C doc/best-practice/build/pdf + mkdir -p doc/build/pdf + cp doc/best-practice/build/pdf/wafd-best-practice.pdf doc/build/pdf/ + + [doc8] ignore = D001