Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
dockerfiles
.dockerignore
.gitignore
CHANGELOG.rst
LICENSE
Makefile
README.rst
VERSION

README.rst

TTD Doc8

Style checker for rst

Based on doc8.

Dependencies

Installation

Pull the image:

docker pull testthedocs/ttd-doc8

Usage

Run ttd-doc8 from in your docs directory:

docker run -it -v `pwd`:/srv/data testthedocs/ttd-doc8

Checks

  • Invalid rst format - D000
  • Lines should not be longer than 180 characters - D001
    • RST exception: line with no whitespace except in the beginning
    • RST exception: lines with http or https urls
    • RST exception: literal blocks
    • RST exception: rst target directives
  • No trailing whitespace - D002
  • No tabulation for indentation - D003
  • No carriage returns (use unix newlines) - D004
  • No newline at end of file - D005

Contribute

Support

If you are having issues, please let us know.

License

MIT