openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Use linters target

Browse Source 
The linters target is new default going forward, update docs.

Change-Id: I69e3f823890e5bedefb3e8af49b64d265234dc1a
This commit is contained in:
Andreas Jaeger 2017-10-09 16:44:16 +02:00
parent adefde9826
commit eee3c422a2
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -84,7 +84,7 @@ If you like to run individual tests, run:
* ``tox -e checkbuild`` - to actually build the manual
* ``tox -e checklang`` - to build translated manuals
* ``tox -e checkniceness`` - to run the niceness tests
* ``tox -e linters`` - to run the niceness tests
* ``tox -e linkcheck`` - to run the tests for working remote URLs
The ``tox`` command uses the openstack-doc-tools package to run the

2
doc/doc-contrib-guide/source/docs-builds.rst
View File

@ -172,7 +172,7 @@ command from the base directory of repository:
The following individual checks are also available:
* :command:`tox -e checkniceness` - to run the niceness tests (for example,
* :command:`tox -e linters` - to run the lint tests (for example,
to see extra whitespaces)
* :command:`tox -e checklang` - to check all the translated manuals
* :command:`tox -e docs` - to build only RST-sourced manuals

2
doc/doc-contrib-guide/source/rst-conv/general-guidelines.rst
View File

@ -27,7 +27,7 @@ Space and tab characters
* Do not use tab characters within the code, use space characters instead.
* Do not place space characters at the end of lines. If used,
the checkniceness test will fail because of trailing whitespaces.
the linters test will fail because of trailing whitespaces.
Indentation
~~~~~~~~~~~