OpenStack Manuals
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

108 lines
2.9 KiB

minversion = 2.0
envlist = linters,publishdocs
skipsdist = True
setenv =
deps = -r{toxinidir}/test-requirements.txt
passenv = ZUUL_*
whitelist_externals =
commands = {posargs}
commands =
{toxinidir}/tools/ --linkcheck
commands =
doc8 doc
commands =
commands =
{toxinidir}/tools/ --pdf
commands =
{toxinidir}/tools/ \
doc/{posargs} \
--build build \
--target {posargs}
# Prepare all documents (except www subdir) so that they can get
# published on with just copying publish-docs/*
# over.
commands =
{toxinidir}/tools/ publish
whereto publish-docs/html/.htaccess publish-docs/html/redirect-tests.txt
rm publish-docs/html/redirect-tests.txt
# Run as "tox -e buildlang -- $LANG"
whitelist_externals = doc-tools-check-languages
commands =
doc-tools-check-languages doc-tools-check-languages.conf test {posargs}
whitelist_externals = doc-tools-check-languages
commands =
doc-tools-check-languages doc-tools-check-languages.conf publish all
# Move from publish-docs to publish-docs/html
# TODO(AJaeger): Remove once openstack-doc-tools is updated
mkdir publish-docs-new
mv publish-docs publish-docs-new/html
mv publish-docs-new publish-docs
# Generate POT files for translation, needs {posargs} like:
# tox -e generatepot-rst -- user-guide
commands = {toxinidir}/tools/ openstack-manuals 1 {posargs}
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files, and develop mode disabled
# explicitly to avoid unnecessarily installing the checked-out repo too (this
# further relies on "tox.skipsdist = True" above).
deps = bindep
commands = bindep test
usedevelop = False
# Settings for doc8:
# Ignore target directories and autogenerated files
ignore-path = doc/*/target,doc/*/build*
# File extensions to use
extensions = .rst,.txt
# Maximal line length should be 79 but we have some overlong lines.
# Let's not get far more in.
max-line-length = 79
# Disable some doc8 checks:
# D000: Check RST validity (cannot handle the "linenos" directive)
ignore = D000
show-source = True
builtins = _