style checker for sphinx (or other) rst documentation.
Project description
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)
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.1.tar.gz
(6.6 kB
view details)
File details
Details for the file doc8-0.3.1.tar.gz.
File metadata
- Download URL: doc8-0.3.1.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 05bf4c8dca5af9f3f2657837eea2de12834cbe4c7d1c605d9469c2ff6c6fb984 |
|
| MD5 | 2c7a709d70ac0f1a8a46cce0d7c1655e |
|
| BLAKE2b-256 | 588b7ed33920c1cd862ec90fe436c3b377c01f267f4a6e07044b67443b841de8 |
