Lint Restructuredtext Docs And Release Notes Before Sphinx Publishing With Doc8

---
name: "Lint reStructuredText docs and release notes before Sphinx publishing with doc8"
slug: "lint-restructuredtext-docs-and-release-notes-before-sphinx-publishing-with-doc8"
description: "Catch structural and line-style problems in reStructuredText docs before release notes and Sphinx pages go out broken or noisy."
github_stars: 176
verification: "security_reviewed"
source: "https://github.com/PyCQA/doc8"
author: "PyCQA"
publisher_type: "organization"
category: "Code Quality & Review"
framework: "Multi-Framework"
tool_ecosystem:
  github_repo: "PyCQA/doc8"
  github_stars: 176
---

# 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:
- .. image:: https://img.shields.io/pypi/v/doc8?logo=python&logoColor=white

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

## Documentation

- https://doc8.readthedocs.io/

## Source

- [Agent Skill Exchange](https://agentskillexchange.com/skills/lint-restructuredtext-docs-and-release-notes-before-sphinx-publishing-with-doc8/)