x/doc8
Code Issues Proposed changes
Style checker for sphinx (or other) rst documentation.
59 Commits 1 Branch 12 Tags 632 KiB
1a6a4658b4
Go to file
Joshua Harlow 1a6a4658b4 Use stevedore for dynamic check inclusion 
Allow checks to be created outside of doc8
and use stevedore to load these check objects
and use them when checking.
2014-05-18 20:29:57 -07:00
doc8 Use stevedore for dynamic check inclusion 2014-05-18 20:29:57 -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 the max-line-length to the usage help 2014-05-18 18:39:23 -07:00
setup.cfg Fixed a typo 2014-05-17 21:27:26 -07:00
setup.py Use stevedore for dynamic check inclusion 2014-05-18 20:29:57 -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

Usage

$ ./doc8  -h
usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code]
            [path [path ...]]

Check documentation for simple style requirements.

What is checked:
    - lines should not be longer than 79 characters - D001
      - exception: line with no whitespace except in the beginning
      - exception: lines with http or https urls
      - exception: literal blocks
      - exception: rst target directives
    - no trailing whitespace - D002
    - no tabulation for indentation - D003
    - no carriage returns (use unix newlines) - D004

positional arguments:
  path                 path to scan for *.rst, *.txt files (default:
                       os.getcwd())

optional arguments:
  -h, --help           show this help message and exit
  --config path        user config file location (default: doc8.ini, tox.ini,
                       pep8.ini, setup.cfg)
  --allow-long-titles  allow long section titles (default: False)
  --ignore code        ignore the given errors code/codes
  --max-line-length int
                       maximum allowed line length (default: 79)