Use doc8 to verify rst files

[Danny Al-Gaaf]

It would be useful if the tox run would also identify issues in the documentation. For this we could make use of doc8 e.g. in the pep8 section or in a separate doc8 section. Later these checks could also be activated in the gate to prevent new doc issues.

For doc8 see e.g. openstack-doc-tools which is already using it and the documenation https://pypi.python.org/pypi/doc8

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/310591

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sean McGinnis (<email address hidden>) on branch: master
Review: https://review.openstack.org/310591
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/310591
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=e3e749fa30f185861d12dbf953881d4372a853f0
Submitter: Jenkins
Branch: master

commit e3e749fa30f185861d12dbf953881d4372a853f0
Author: Danny Al-Gaaf <email address hidden>
Date: Wed Feb 1 17:02:18 2017 +0100

    doc: verify all rst files

    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 <email address hidden>

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/cinder 11.0.0.0b1 development milestone.