# 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.

- Skill: `agentskillexchange/lint-restructuredtext-docs-and-release-notes-before-sphinx-p` (Agent Skill)
- Install (CLI): `npx skillmds@latest add agentskillexchange/lint-restructuredtext-docs-and-release-notes-before-sphinx-p`
- Raw SKILL.md: https://api.skillmd.com/api/skills/agentskillexchange/lint-restructuredtext-docs-and-release-notes-before-sphinx-p/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: agentskillexchange (https://skillmd.com/u/agentskillexchange)
- Updated: 2026-09-08
- Page: https://skillmd.com/skills/agentskillexchange/lint-restructuredtext-docs-and-release-notes-before-sphinx-p

---


# 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/)