OpenStack Shared File Systems Service (Manila)

Use doc8 to verify rst files

Bug #1664841 reported by Danny Al-Gaaf on 2017-02-15

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	OpenStack Shared File Systems Service (Manila)	Fix Released	Undecided	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 https://pypi.python.org/pypi/doc8

Danny Al-Gaaf (danny-al-gaaf) on 2017-02-15

Changed in manila:
assignee:	nobody → Danny Al-Gaaf (danny-al-gaaf)

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2017-02-15: Fix proposed to manila (master)

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

Changed in manila:
status:	New → In Progress

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2017-02-16: Fix merged to manila (master)

Reviewed: https://review.openstack.org/434086
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=a8ec3317be53b1bef23522e713a3f6e02ebbb505
Submitter: Jenkins
Branch: master

commit a8ec3317be53b1bef23522e713a3f6e02ebbb505
Author: Danny Al-Gaaf <email address hidden>
Date: Wed Feb 15 07:07:42 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: #1664841

Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f
Signed-off-by: Danny Al-Gaaf <email address hidden>