x
/
doc8
Code Issues Proposed changes
Style checker for sphinx (or other) rst documentation.
2 Commits 1 Branch 12 Tags 632 KiB
Go to file
Joshua Harlow 870b28f86e Add doc8 files 2014-05-17 18:58:47 -07:00
scripts Add doc8 files 2014-05-17 18:58:47 -07:00
.gitignore Initial commit 2014-05-17 18:46:57 -07:00
LICENSE Initial commit 2014-05-17 18:46:57 -07:00
MANIFEST.in Add doc8 files 2014-05-17 18:58:47 -07:00
README.rst Add doc8 files 2014-05-17 18:58:47 -07:00
setup.py Add doc8 files 2014-05-17 18:58:47 -07:00

README.rst

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