openstack-helm/tox.ini
Doug Goldstein 178c777c1e
use helm-docs to generate docs for the values.yaml
For each chart, generate configuration docs for the values.yaml
Install helm-docs into the tools directory since it's not available via
distro packages.

Change-Id: Icffec6637686871d10aba2f666075549d1d505a8
Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
2024-11-22 09:37:45 -06:00

57 lines
1.3 KiB
INI

[tox]
minversion = 3.1
envlist = docs
skipsdist = True
ignore_basepython_conflict = True
[testenv]
basepython = python3
setenv = VIRTUAL_ENV={envdir}
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
passenv = *_proxy,*_PROXY
[testenv:venv]
commands = {posargs}
[testenv:docs]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build
make helm-docs
sphinx-build -W --keep-going -b html -j auto doc/source doc/build/html
allowlist_externals =
make
rm
[testenv:pdf-docs]
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
allowlist_externals =
make
rm
commands =
rm -rf doc/build/pdf
make helm-docs
sphinx-build -W --keep-going -b latex -j auto doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:lint]
deps =
yq
yamllint
commands =
rm -rf .yamllint
bash -c 'if [ ! -d ../openstack-helm-infra ]; then \
git clone https://opendev.org/openstack/openstack-helm-infra ../openstack-helm-infra; \
fi'
bash ../openstack-helm-infra/tools/gate/lint.sh
allowlist_externals =
rm
bash
[testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html