openstack/cinder
Code Issues Proposed changes

doc: verify all rst files

Browse Source 
Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.

Fix all issues found by doc8.

Closes-Bug: #1566765

Change-Id: I2b25247030a1aadcfe029c9e071ef17f2f72046b
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
This commit is contained in:
Danny Al-Gaaf 2017-02-01 17:02:18 +01:00
parent c4ea8f598d
commit e3e749fa30
5 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/README.rst
View File

@ -14,8 +14,8 @@ Tools
Sphinx Sphinx
The Python Sphinx package is used to generate the documentation output. The Python Sphinx package is used to generate the documentation output.
Information on Sphinx, including formatting information for RST source Information on Sphinx, including formatting information for RST source
files, can be found in the `Sphinx online documentation files, can be found in the
<http://www.sphinx-doc.org/en/stable/>`_. `Sphinx online documentation <http://www.sphinx-doc.org/en/stable/>`_.
Graphviz Graphviz
Some of the diagrams are generated using the ``dot`` language Some of the diagrams are generated using the ``dot`` language

9
doc/source/devref/attach_detach_conventions_v2.rst
View File

@ -60,10 +60,11 @@ will create the attachment and perform the update on the attachment to set the
connector info and return the connection data needed to make a connection. connector info and return the connection data needed to make a connection.
The attachment_create call can be used in one of two ways: The attachment_create call can be used in one of two ways:
1. Create an empty Attachment object (reserve)
attachment_create call. In this case the attachment_create call requires 1. Create an empty Attachment object (reserve) attachment_create call. In this
an instance_uuid and a volume_uuid, and just creates an empty attachment case the attachment_create call requires an instance_uuid and a volume_uuid,
object and returns the UUID of said attachment to the caller. and just creates an empty attachment object and returns the UUID of said
attachment to the caller.
2. Create and Complete the Attachment process in one call. The Reserve process 2. Create and Complete the Attachment process in one call. The Reserve process
is only needed in certain cases, in many cases Nova actually has enough is only needed in certain cases, in many cases Nova actually has enough

2
rally-jobs/plugins/README.rst
View File

@ -1,7 +1,7 @@
Rally plugins Rally plugins
============= =============
All *.py modules from this directory will be auto-loaded by Rally and all All ``*.py`` modules from this directory will be auto-loaded by Rally and all
plugins will be discoverable. There is no need of any extra configuration plugins will be discoverable. There is no need of any extra configuration
and there is no difference between writing them here and in rally code base. and there is no difference between writing them here and in rally code base.

1
test-requirements.txt
View File

@ -25,3 +25,4 @@ os-testr>=0.8.0 # Apache-2.0
tempest>=12.1.0 # Apache-2.0 tempest>=12.1.0 # Apache-2.0
bandit>=1.1.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0
doc8 # Apache-2.0

1
tox.ini
View File

@ -98,6 +98,7 @@ commands =
python setup.py build_sphinx python setup.py build_sphinx
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/ sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/
doc8 --ignore D001 --ignore-path .tox --ignore-path cinder.egg-info --ignore-path doc/src/api --ignore-path doc/source/drivers.rst --ignore-path doc/build -e txt -e rst
whitelist_externals = rm whitelist_externals = rm
[testenv:gendriverlist] [testenv:gendriverlist]