Open Stack

On 2018-06-06 18:24:00 +0200 (+0200), Dmitry Tantsur wrote:
> In Ironic world we run doc8 on README.rst as part of the pep8 job.
> Maybe we should make it a common practice?
[...]

First, the doc8 tool should be considered generally useful for any
project with Sphinx-based documentation, regardless of whether it's
a Python project. Second, doc8 isn't going to necessarily turn up
the same errors as `python setup.py check --restructuredtext
--strict` since the latter is focused on validating that the
long description (which _might_ be in a file referenced from your
documentation tree, but also might not!) for your Python package is
suitable for rendering on PyPI.
-- 
Jeremy Stanley
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 963 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20180606/b37a548f/attachment.sig>