style checker for sphinx (or other) rst documentation.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Joshua.Harlow from gravatar.com Joshua.Harlow Avatar for pycqa from gravatar.com pycqa Avatar for ssbarnea from gravatar.com ssbarnea

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (ASL 2.0)
  • Author: UNKNOWN
  • Tags rst, docs, style, checking
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Joshua.Harlow from gravatar.com Joshua.Harlow Avatar for pycqa from gravatar.com pycqa Avatar for ssbarnea from gravatar.com ssbarnea

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (ASL 2.0)
  • Author: UNKNOWN
  • Tags rst, docs, style, checking
Classifiers

Release history Release notifications | RSS feed

1.1.2

1.1.1

1.0.0

0.11.2

0.11.1

0.11.0

0.10.1

0.10.0 yanked

Reason this release was yanked:

packaging is broken

0.9.1

0.9.0

0.8.1

0.8.0

0.7.0

0.6.0

0.5.0

0.4.3

0.4.2

0.4.1

0.4.0

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.1

0.2.0

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

This version

0.1

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for doc8-0.1.tar.gz
Algorithm Hash digest
SHA256 46cf12e6c929f3fe53db444b3fcc91ed0bfe161b468eea2134d7bfee0e753b7c
MD5 87f3f78079917bbf58cf35f4de69f136
BLAKE2b-256 75c3f5a1b8b5402532d48c8c4c474c5217b19d703854271656208dc5d910acff

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