doc8 ☆
« Back to VersTracker
Description:
Style checker for Sphinx documentation
Type: Formula  |  Latest Version: 2.0.0@0  |  Tracked Since: Dec 17, 2025
Links: Homepage  |  formulae.brew.sh
Category: Developer tools
Tags: documentation linter sphinx restructuredtext python
Install: brew install doc8
About:
doc8 is a command-line tool designed to enforce consistent style and formatting rules in reStructuredText (reST) documentation. It scans documentation source files for common errors and style violations, helping maintain high-quality Sphinx projects. By automating these checks, it ensures readability and consistency across documentation.
Key Features:
  • Checks for common reStructuredText style violations
  • Validates code block indentation and formatting
  • Configurable via a pyproject.toml or .doc8 configuration file
  • Fast and lightweight, suitable for CI/CD pipelines
Use Cases:
  • Enforcing style guidelines in Sphinx documentation projects
  • Integrating documentation linting into automated CI/CD workflows
Alternatives:
  • rstcheck – rstcheck focuses more on syntax validation, while doc8 is specifically designed for style and formatting rules.
License: Apache-2.0
Dependencies: python@3.14
Bottles available for: all
Version History
Detected Version Rev Change Commit
Oct 10, 2024 4:32pm 0 VERSION_BUMP c903c61b
Oct 10, 2024 8:43am 0 VERSION_BUMP 85a63776
Sep 12, 2024 5:33pm 0 VERSION_BUMP 83c39f29
« Back to VersTracker  |  Browse Packages  |  About