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.

agentskillexchange Updated 28 repo stars

File contents

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:


Documentation

Source

agentskillexchange/skills/tree/main/skills/lint-restructuredtext-docs-and-release-notes-before-sphinx-publishing-with-doc8 commit 5d2758151c

Frequently asked questions

npx skillmds@latest add agentskillexchange/lint-restructuredtext-docs-and-release-notes-before-sphinx-p