Contents

doc8 1.1.2

0

Style checker for Sphinx (or other) RST documentation

Style checker for Sphinx (or other) RST documentation

Stars: 161, Watchers: 161, Forks: 36, Open Issues: 20

The PyCQA/doc8 repo was created 10 years ago and the last code push was 3 days ago.
The project is popular with 161 github stars!

How to Install doc8

You can install doc8 using pip

pip install doc8

or add it to a project with poetry

poetry add doc8

Package Details

Author
None
License
Apache 2.0
Homepage
None
PyPi:
https://pypi.org/project/doc8/
Documentation:
https://doc8.readthedocs.io
GitHub Repo:
https://github.com/pycqa/doc8

Classifiers

  • System/Systems Administration
  • Utilities
No  doc8  pypi packages just yet.

Errors

A list of common doc8 errors.

Code Examples

Here are some doc8 code examples and snippets.

GitHub Issues

The doc8 package has 20 open issues on GitHub

  • Add ability to load .config/doc8.ini

See more issues on GitHub

Related Packages & Articles

ansible-lint 24.9.2

Checks playbooks for practices and behavior that could potentially be improved

bandit 1.7.10

Security oriented static analyser for python code.

cfn-lint 1.16.1

Checks CloudFormation templates for practices and behaviour that could potentially be improved

tox 4.21.2

tox is a generic virtualenv management and test command line tool