# Install doc8 with Homebrew Style checker for Sphinx documentation. Version 2.0.0 via Homebrew; verified 2026-06-13. ## Install ```sh sudo av install brew:doc8 ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install doc8 ``` Evidence: local Homebrew formula metadata ## Package facts - **Package key:** brew:doc8 - **Package manager:** Homebrew - **Package manager page:** - **Version:** 2.0.0 - **Source summary:** Style checker for Sphinx documentation - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** Apache-2.0 - **Source archive:** - **Last updated:** 2026-06-13T01:24:09+02:00 - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - doc8 (cli) - doc8 (alias) ## Dependencies - python@3.14 ## Install behavior - Post-install hook: not defined - Bottle: available on all ## Freshness - Page generated: 2026-07-08 - Package-manager version: 2.0.0 - Package-manager updated: 2026-06-13 - Local data: ok - Upstream repository: https://github.com/PyCQA/doc8 - info: No cached GitHub release or tag data was available. ## 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 Notes narrow executable package without higher-risk signals. - **Geiger risk:** green / low - narrow executable package without higher-risk signals ## 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 - Unix: ./doc8.ini, ./.config/doc8.ini, ./tox.ini, ./pep8.ini, ./setup.cfg, ./pyproject.toml ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** doc8 - **Version Scheme:** 0 - **Revision:** 1 - **Head Version:** HEAD - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** head, stable ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [python@3.14](https://www.automicvault.com/pkg/brew/python-3-14/) - Runtime dependency declared by Homebrew. - [rst-lint](https://www.automicvault.com/pkg/brew/rst-lint/) - Shares av.db curated category or tags: cli, developer-tools, documentation, linter, linting. - [restview](https://www.automicvault.com/pkg/brew/restview/) - Shares av.db curated category or tags: cli, developer-tools, documentation, restructuredtext, rst. - [docutils](https://www.automicvault.com/pkg/brew/docutils/) - Shares av.db curated category or tags: cli, developer-tools, documentation, restructuredtext. - [textidote](https://www.automicvault.com/pkg/brew/textidote/) - Shares av.db curated category or tags: cli, developer-tools, documentation, linting. - [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [adr-tools](https://www.automicvault.com/pkg/brew/adr-tools/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [adr-viewer](https://www.automicvault.com/pkg/brew/adr-viewer/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [cargo-docset](https://www.automicvault.com/pkg/brew/cargo-docset/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [proselint](https://www.automicvault.com/pkg/brew/proselint/) - Both packages touch the same language runtime or ecosystem. Shared terms: checker, cli, developer, developer-tools, linter. - [vint](https://www.automicvault.com/pkg/brew/vint/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, linter, linting. ## Combined YAML source View the package source record on GitHub. [combined/doc8.yml](https://github.com/automic-vault/db/blob/main/combined/doc8.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - cross-ecosystem install command graph