macOS
Homebrewverifiziert · 100%
brew install doc8local Homebrew formula metadata
brew
doc8 mit Homebrew installieren
Prüfe Installationswege, Executables, Metadaten und Sicherheitshinweise für doc8 in AI-Agent-Workflows.
Installation
Weitere Installationsbefehle
Überblick
Paketzusammenfassung
Style checker for Sphinx documentation
Projektlinks
Befehle und Aliase
- doc8
Verlauf
Projektgeschichte und Nutzung
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.
Projektgeschichte
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.
Adoptionsgeschichte
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.
Wie es verwendet wird
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.
Warum Paket-Nerds sich dafür interessieren
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.
Zeitleiste
- 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.
Quellen
Sicherheitslage
Risikostufe: grün
narrow executable package without higher-risk signals.
Risikoklassifikator
grün Risiko · niedrig Konfidenz · appliance
Warum
- narrow executable package without higher-risk signals
Signale
- metadata:no-higher-risk-signals
Installationsverhalten
- In den Formelmetadaten ist kein Homebrew-Post-install-Hook erfasst.
- Homebrew-Bottle-Metadaten sind für 1 Plattformziele verfügbar.
- Installiert mit 1 Laufzeitabhängigkeiten.
Empfohlene Prüfung
Prüfe vor unbeaufsichtigter Agent-Nutzung, ob das Tool Klartext-Credentials liest, Remote-Zustand schreibt, Artefakte veröffentlicht oder Plugins ausführt.
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
Installierte Executables
| Befehl | Art | Sichtbarkeit | Hinweis |
|---|---|---|---|
doc8 | cli | globales Executable |
Aktualität
Version und Aktualität
Diese Signale trennen das Alter der Seitengenerierung, Aktivität des Paketmanagers und Upstream-Release-Vergleich. Versionsrückstand wird nur gemeldet, wenn eine Evidenz-URL und vergleichbare Versionen vorhanden sind.
Seite generiert2026-07-25
Manager-Version2.0.0
Manager aktualisiert2026-06-13
lokale DatenOK
Upstreamnot checked
neueste erkannte Versionnicht erkannt
- InfoNo cached GitHub release or tag data was available.https://github.com/PyCQA/doc8none Konfidenz
Installationsmetadaten
Paketmetadaten
| Paketschlüssel | brew:doc8 |
|---|---|
| Version | 2.0.0 |
| Paketmanager | Homebrew |
| Paketmanager-Seite | https://formulae.brew.sh/formula/doc8 |
| Homepage | https://github.com/PyCQA/doc8 |
| Repository | https://github.com/PyCQA/doc8 |
| Upstream-Dokumentation | https://doc8.readthedocs.io/ |
| Lizenz | Apache-2.0 |
| Quellarchiv | https://files.pythonhosted.org/packages/92/91/88bb55225046a2ee9c2243d47346c78d2ed861c769168f451568625ad670/doc8-2.0.0.tar.gz |
| Zuletzt aktualisiert | 2026-06-13T01:24:09+02:00 |
| Pulse | updated |
| Abhängigkeiten | python@3.14 |
| Bottle | verfügbar (auf all) |
| Homebrew post-install | nicht definiert |
| Dienst | keiner deklariert |
Registry-Fakten
Details aus der Quelldatenbank
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | doc8 |
| Version Scheme | 0 |
| Revision | 1 |
| Head Version | HEAD |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
Quellspur
Aus Repository-Daten generiert
Diese Seite wird von av-web aus dem privaten Paket-SQLite-Artefakt bereitgestellt, das scripts/generate-pkg-sqlite.py erstellt.
Combined YAML source
View the package source record on GitHub.
Verwendete Quellen
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment