Use doc8 style checker

This uses the doc8 style checker to check that document
files conform to certain requirements, as documented at
    https://pypi.python.org/pypi/doc8.

Some files were modified because they had lines that
were longer than 79 characters.

Change-Id: I94e081e197898359676821cfcf8cb1133ed28bc5
This commit is contained in:
Ruby Loo 2015-09-30 23:25:23 +00:00
parent 9aa761f8b7
commit 824025bb64
4 changed files with 8 additions and 3 deletions

View File

@ -7,8 +7,10 @@ ironicclient Python API
The ironicclient python API lets you access ironic, the OpenStack The ironicclient python API lets you access ironic, the OpenStack
Bare Metal Provisioning Service. Bare Metal Provisioning Service.
For example, to manipulate nodes, you interact with an `ironicclient.v1.node`_ object. For example, to manipulate nodes, you interact with an
You obtain access to nodes via attributes of the `ironicclient.v1.client.Client`_ object. `ironicclient.v1.node`_ object.
You obtain access to nodes via attributes of the
`ironicclient.v1.client.Client`_ object.
Usage Usage
===== =====

View File

@ -37,7 +37,8 @@ environment variables::
The command-line tool will attempt to reauthenticate using the provided The command-line tool will attempt to reauthenticate using the provided
credentials for every request. You can override this behavior by manually credentials for every request. You can override this behavior by manually
supplying an auth token using :option:`--ironic-url` and supplying an auth token using :option:`--ironic-url` and
:option:`--os-auth-token`, or by setting the corresponding environment variables:: :option:`--os-auth-token`, or by setting the corresponding environment
variables::
export IRONIC_URL=http://ironic.example.org:6385/ export IRONIC_URL=http://ironic.example.org:6385/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

View File

@ -4,6 +4,7 @@
hacking<0.11,>=0.10.0 hacking<0.11,>=0.10.0
coverage>=3.6 coverage>=3.6
discover discover
doc8 # Apache-2.0
fixtures>=1.3.1 fixtures>=1.3.1
httpretty<0.8.7,>=0.8.4 httpretty<0.8.7,>=0.8.4
mock>=1.2 mock>=1.2

View File

@ -25,6 +25,7 @@ downloadcache = ~/cache/pip
[testenv:pep8] [testenv:pep8]
commands = commands =
flake8 {posargs} flake8 {posargs}
doc8 doc/source CONTRIBUTING.rst README.rst
[testenv:cover] [testenv:cover]
setenv = VIRTUAL_ENV={envdir} setenv = VIRTUAL_ENV={envdir}