doc8/README.rst

304 B

Doc8

Doc8 is a opinionated style checker for sphinx (or other) rst documentation.

QuickStart

pip install doc8

To run doc8 just invoke it against any doc directory:

$ doc8 coolproject/docs