7d35411529
This patch adds a `pdf-docs` tox target that will build PDF versions of our docs. As per the Train community goal: https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Story: 2006122 Task: 35513 Change-Id: I89db230c31464a89a82aa72b86348f51b61990ca
51 lines
1.3 KiB
INI
51 lines
1.3 KiB
INI
[tox]
|
|
envlist = py{27,35,36,37,38,39,310}-compilelibs,pep8,docs
|
|
|
|
[testenv]
|
|
deps =
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands=
|
|
pytest -v test/
|
|
setenv = LIBERASURECODE_DIR={envdir}/liberasurecode
|
|
NASM_DIR={envdir}/nasm
|
|
ISAL_DIR={envdir}/isa-l
|
|
JERASURE_DIR={envdir}/jerasure
|
|
GFCOMPLETE_DIR={envdir}/gf-complete
|
|
passenv = LIBERASURECODE_REF
|
|
allowlist_externals =
|
|
compilelibs: {toxinidir}/tools/pip-install-with-liberasurecode.sh
|
|
install_command =
|
|
compilelibs: {toxinidir}/tools/pip-install-with-liberasurecode.sh {opts} {packages}
|
|
!compilelibs: pip install {opts} {packages}
|
|
|
|
[testenv:pep8]
|
|
skip_install = True
|
|
deps=
|
|
hacking
|
|
commands=
|
|
flake8 pyeclib/ setup.py test/
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
deps =
|
|
-r{toxinidir}/doc/requirements.txt
|
|
commands =
|
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
|
|
|
[testenv:pdf-docs]
|
|
deps = {[testenv:docs]deps}
|
|
allowlist_externals =
|
|
make
|
|
commands =
|
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
|
make -C doc/build/pdf
|
|
|
|
[flake8]
|
|
# H101: Use TODO(NAME)
|
|
# H404: multi line docstring should start without a leading new line
|
|
# H405: multi line docstring summary not separated with an empty line
|
|
# W504: line break after binary operator
|
|
ignore = H101,H404,H405,W504
|