Use doc8 to verify rst files

Bug #1566765 reported by Danny Al-Gaaf
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fix Released
Danny Al-Gaaf

Bug Description

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

Changed in cinder:
assignee: nobody → Danny Al-Gaaf (danny-al-gaaf)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

Fix proposed to branch: master

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on cinder (master)

Change abandoned by Sean McGinnis (<email address hidden>) on branch: master
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.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

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>

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder

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

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.