Lint reStructuredText docs and release notes before Sphinx publishing with doc8
Catch structural and line-style problems in reStructuredText docs before release notes and Sphinx pages go out broken or noisy.
Prerequisites
Python and the doc8 CLI in a repository with reStructuredText or plain-text documentation.
Installation
Use the upstream install or setup path that matches your environment:
- pip install doc8
Requirements and caveats from upstream:
Basic usage or getting-started notes:
::
To run doc8, just invoke it against any documentation directory::
Source: https://github.com/PyCQA/doc8
Extracted from upstream docs: https://raw.githubusercontent.com/PyCQA/doc8/HEAD/README.rst