Skip to main content

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

Project details


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.1.6.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file doc8-0.1.6.tar.gz.

File metadata

  • Download URL: doc8-0.1.6.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for doc8-0.1.6.tar.gz
Algorithm Hash digest
SHA256 1ce460f7841decd8d0c604edbf26cd258d14bebf57d2151d63b1c564b0aef10c
MD5 5059e9dae6600e12248a111ee0393202
BLAKE2b-256 9fa8ff5b631c1eb501585734e3a82f9b832d56a7dd4a88c2986125509a5ab7a8

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page