starlingx/specs
Code Issues Proposed changes

Add doc8 linter to tox for spec validation

Browse Source 
This will check the specs for the following when running tox:

linters runtests: commands[1] | doc8 specs/
Scanning...
Validating...
========
Total files scanned = 7
Total files ignored = 0
Total accumulated errors = 0
Detailed error counts:
    - CheckCarriageReturn = 0
    - CheckIndentationNoTab = 0
    - CheckMaxLineLength = 0
    - CheckNewlineEndOfFile = 0
    - CheckTrailingWhitespace = 0
    - CheckValidity = 0

Also fixes:
 - One long line violation in instructions.rst
 - DOS CRLF formatting of
   containerization-2002840-local-docker-registry.rst

Change-Id: I73e1c87401156fe1fd52ab2b5460201f559c6284
Signed-off-by: Robert Church <robert.church@windriver.com>
This commit is contained in:
Robert Church 2018-10-17 12:26:33 -04:00
parent 606c09eab8
commit f2a756f493
4 changed files with 172 additions and 170 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
specs/instructions.rst
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::

1
test-requirements.txt
View File

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

1
tox.ini
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}