security-doc/tox.ini
Andreas Jaeger 036b0dcad9 Enable linter, update for python3
Add a new job to run "tox -e linters" to doc8 the documents.

Remove the black listing of D000, this is not needed for this repo.
Update tox.ini to use Python3 everywhere.

Change-Id: I5ea55e0000efad1dc4c912fd61baaefb8af09973
2019-10-31 17:19:56 +01:00

62 lines
1.5 KiB
INI

[tox]
minversion = 1.6
envlist = linters,publishdocs
skipsdist = True
[testenv]
basepython = python3
setenv =
VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt
whitelist_externals =
bash
cp
mkdir
rm
sed
[testenv:venv]
commands = {posargs}
[testenv:linters]
commands =
doc8 -e '' security-notes
doc8 -e '' security-guide
doc8 -e '' security-threat-analysis
[testenv:publishdocs]
# Prepare all documents so that they can get published on
# docs.openstack.org with just copying publish-docs/* over.
commands =
# Build and copy RST Guides
{toxinidir}/tools/build-all-rst.sh
[testenv:buildlang]
# Run as "tox -e buildlang -- $LANG"
whitelist_externals =
doc-tools-check-languages
bash
commands =
doc-tools-check-languages doc-tools-check-languages.conf test {posargs}
[testenv:publishlang]
whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf test all
[testenv:docs]
commands =
# Build and copy RST Guides
{toxinidir}/tools/build-all-rst.sh
[testenv:generatepot-rst]
# Generate POT files for translation, needs {posargs} like:
# tox -e generatepot-rst -- security-guide
commands = {toxinidir}/tools/generatepot-rst.sh {posargs}
[doc8]
# Settings for doc8:
# This file has extra long lines that cannot be avoided, let's white list it.
ignore-path = security-notes/OSSN-0047,security-notes/OSSN-0068,common,security-guide/build,security-threat-analysis/build
# File extensions to use
extensions = .rst,.txt