macOS
Homebrewverified · 100%
brew install doc8local Homebrew formula metadata
brew / rank 7506
Install doc8 with Homebrew
Style checker for Sphinx documentation. Version 2.0.0 via Homebrew; verified 2026-06-13.
install
Additional install commands
overview
Package summary
Style checker for Sphinx documentation
Project links
Commands and aliases
- doc8
history
Project history and usage
doc8 is an opinionated reStructuredText and plain-text documentation style checker, historically useful for Sphinx-heavy Python documentation projects.
It is a small tool, but it occupies a recognizable niche: applying lint-style feedback to docs instead of code.
Project history
doc8 appeared on PyPI in 2014 and was associated with OpenStack documentation tooling before moving into the PyCQA organization in 2019.
The project now lives under PyCQA, which fits its role as a Python code-quality-adjacent checker for documentation repositories.
Adoption history
Adoption has been strongest in Python projects that already use Sphinx, tox, setup.cfg, pyproject.toml, or pre-commit style workflows.
The tool is distributed primarily through PyPI, with Homebrew packaging providing a convenient CLI install path for macOS and Linux users.
How it is used
doc8 checks documentation trees for simple style requirements, supports common config files, and can be run from the command line or called programmatically.
Projects use it to catch line length, formatting, and reStructuredText issues before docs are built or published.
Why package nerds care
doc8 is a tidy example of documentation linting becoming a normal part of CI, parallel to how flake8, ruff, and other Python linters treat source code.
Its PyCQA home matters: it signals that documentation quality tooling belongs in the same maintenance culture as code quality tooling.
Timeline
- 2014: doc8's early 0.1 and 0.3.x releases appeared on PyPI.
- 2019: OpenStack infrastructure status notes that openstack/doc8 on GitHub was transferred to the PyCQA organization.
- 2022: doc8 1.0.0 marked a stable major release under the PyCQA repository.
- 2025: doc8 2.0.0 raised the Python baseline and refreshed project metadata and build pipelines.
Related projects
- Related projects include Sphinx, docutils, reStructuredText linters, pydocstyle, rstcheck, and PyCQA's broader family of Python quality tools.
- OpenStack documentation tooling is part of doc8's historical context.
Sources
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew bottle metadata was recorded.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
Configuration and credential file locations
These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.
Configuration files
Config paths the tool may read or write during local use.
- Unix
./doc8.ini./.config/doc8.ini./tox.ini./pep8.ini./setup.cfg./pyproject.toml
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
doc8 | executable | indexed executable | Discovered from the local executable index. |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-08-03
manager version2.0.0
manager updated2026-06-13
local dataunknown
upstreamnot available
latest detectednot detected
- okNo freshness warnings were generated.
install metadata
Package metadata
| Package key | brew:doc8 |
|---|---|
| Version | 2.0.0 |
| Package manager | Homebrew |
| Homepage | https://github.com/PyCQA/doc8 |
| Repository | https://github.com/PyCQA/doc8 |
| Last updated | 2026-06-13T01:24:09+02:00 |
| Pulse | updated |
| Bottle | not recorded |
| Service | none declared |
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- pkg.so package database
- pkgdb category and tag curation