478b87b106
When doc8 scans rst files with sphinx specific roles and references it is unable to determine what those roles are and then complains that these false positives are actual errors. To avoid these types of false positives add a option that can be provided when running on files that may contain these types of errors to allow them to be skipped/ignored. Change-Id: Ia6896617534f68e517d5996d53cf2de274507f56 |
||
---|---|---|
doc/source | ||
doc8 | ||
.gitignore | ||
.gitreview | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
pylintrc | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
Doc8
Doc8 is a opinionated style checker for sphinx (or other) rst documentation.
Features
- Ability to parse and validate rst files.
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]
[--ignore-path path] [--max-line-length int] [-e extension]
[path [path ...]]
Check documentation for simple style requirements.
What is checked:
- invalid rst format - D000
- 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 doc 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
--no-sphinx do not ignore sphinx specific false positives
--ignore-path path
ignore the given directory or file
--max-line-length int
maximum allowed line length (default: 79)
-e extension, --extension extension
check file extensions of the given type (default:
.rst, .txt)