Merge "Add doc8 linter to tox for spec validation"

This commit is contained in:
Zuul 2018-10-23 16:05:13 +00:00 committed by Gerrit Code Review
commit e6a355ae61
4 changed files with 172 additions and 170 deletions

View File

@ -34,13 +34,13 @@ encouraged to use index entries for their documents to help with discovery.
Naming
------
Document naming standards help readers find specs. For the StarlingX repository,
the following document naming is recommended. The categories listed here are
likely incomplete, and may need expansion to cover new cases. It is preferrable
to deviate (and hopefully amend the list) than force document names into
nonsense categories. Prefer using categories that have previously been used or
that are listed here over new categories, but don't force the category into
something that doesn't make sense.
Document naming standards help readers find specs. For the StarlingX
repository, the following document naming is recommended. The categories listed
here are likely incomplete, and may need expansion to cover new cases. It is
preferrable to deviate (and hopefully amend the list) than force document names
into nonsense categories. Prefer using categories that have previously been
used or that are listed here over new categories, but don't force the category
into something that doesn't make sense.
Document names should follow a pattern as follows::

View File

@ -1,2 +1,3 @@
PyYAML>=3.1.0
yamllint>=0.5.2
doc8

View File

@ -24,6 +24,7 @@ commands =
\( -name .tox -prune \) \
-o -type f -name '*.yaml' \
-print0 | xargs -0 yamllint"
doc8 specs/
[testenv:venv]
commands = {posargs}