openstack/octavia
Code Issues Proposed changes

Have doc8 ignore autodoc content

Browse Source 
Sphinx autodoc is genereating titles that are too long do to the depth of
the module paths in octavia. This patch tells doc8 to ignore the auto
generated content.

Change-Id: I63333dad11a35a2e62569549b07c2e6a99b4e192
This commit is contained in:
Michael Johnson
2017-12-07 16:26:39 -08:00
parent eb27359cd2
commit f7bc994819
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
tox.ini
View File

@ -55,10 +55,11 @@ commands = oslo_debug_helper {posargs}
[testenv:pep8]
commands = flake8
# RST linter
doc8 specs doc/source octavia \
CONSTITUTION.rst HACKING.rst README.rst TESTING.rst
# Run security linter
# RST linter
doc8 --ignore-path doc/source/contributor/modules specs \
doc/source octavia CONSTITUTION.rst HACKING.rst README.rst \
TESTING.rst
# Run security linter
bandit -r octavia -ll -ii -x octavia/tests
# Make sure specs follow our template
find . -type f -name "*.pyc" -delete