899a36e341
The user can choose - if warnings should be ignored (SKIP_SPHINX_WARNINGS=1) - if warnings on translation build should be on (SPHINX_WARNINGS_TRANS=1) added an example to the previously releasenotes Change-Id: I1486139fdbdef5dd4e00a38c9cb751a5ed7881c6
25 lines
789 B
YAML
25 lines
789 B
YAML
---
|
|
features:
|
|
- |
|
|
Add tools for building translated documents. The file
|
|
``docstheme-build-translated.sh`` will look for translations and
|
|
build translated documents for all languages that exist.
|
|
Invoke ``docstheme-build-translated.sh`` from tox.ini instead of running
|
|
``sphinx-build`` directly.
|
|
The following environment variables control the script:
|
|
``SKIP_SPHINX_WARNINGS`` to not treat warnings from sphinx-build as an
|
|
error.
|
|
``SPHINX_WARNINGS_TRANS`` will turn on warnings by sphinx-build as
|
|
an error on translation (use with caution).
|
|
|
|
Example for tox.ini:
|
|
|
|
::
|
|
|
|
[testenv:docs]
|
|
deps = -r{toxinidir}/doc/requirements.txt
|
|
setenv =
|
|
SKIP_SPHINX_WARNINGS=1
|
|
commands=
|
|
docstheme-build-translated.sh
|