Style checker for Sphinx (or other) RST documentation
Project description
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)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
doc8-0.3.8.tar.gz
(16.5 kB
view hashes)
Built Distribution
doc8-0.3.8-py2.py3-none-any.whl
(12.8 kB
view hashes)
