macOS
Homebrewvérifié · 100%
brew install doc8local Homebrew formula metadata
brew
Installer doc8 avec Homebrew
Consultez les chemins d'installation, exécutables, métadonnées et notes de sécurité de doc8 pour les workflows d'agents IA.
installation
Commandes d'installation supplémentaires
aperçu
Résumé du paquet
Style checker for Sphinx documentation
Liens du projet
Commandes et alias
- doc8
historique
Historique du projet et usages
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.
Historique du projet
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.
Historique d'adoption
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.
Modes d'utilisation
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.
Pourquoi les passionnés de paquets s'y intéressent
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.
Chronologie
- 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
posture de sécurité
Niveau de risque : vert
narrow executable package without higher-risk signals.
Classificateur de risque
risque vert · confiance faible · appliance
Pourquoi
- narrow executable package without higher-risk signals
Signaux
- metadata:no-higher-risk-signals
Comportement d'installation
- Aucun hook post-install Homebrew n’est enregistré dans les métadonnées de formule.
- Les métadonnées de bottle Homebrew sont disponibles pour 1 plateformes.
- S’installe avec 1 dépendances d’exécution.
Revue recommandée
Avant une utilisation sans surveillance par un agent, vérifiez si l'outil lit des identifiants en clair, écrit un état distant, publie des artefacts ou lance des 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
exécutables
Exécutables installés
| Commande | Type | Exposition | Note |
|---|---|---|---|
doc8 | cli | exécutable global |
fraîcheur
Version et fraîcheur
Ces signaux séparent l'âge de génération de la page, l'activité du gestionnaire de paquets et la comparaison avec les versions amont. Un retard de version n'est signalé que lorsqu'une URL de preuve et des versions comparables sont présentes.
page générée2026-07-25
version du gestionnaire2.0.0
gestionnaire mis à jour2026-06-13
données localesOK
amontnot checked
dernière version détectéenon détecté
- infoNo cached GitHub release or tag data was available.https://github.com/PyCQA/doc8confiance none
métadonnées d'installation
Métadonnées du paquet
| Clé du paquet | brew:doc8 |
|---|---|
| Version | 2.0.0 |
| Gestionnaire de paquets | Homebrew |
| Page du gestionnaire de paquets | https://formulae.brew.sh/formula/doc8 |
| Page d'accueil | https://github.com/PyCQA/doc8 |
| Dépôt | https://github.com/PyCQA/doc8 |
| Docs amont | https://doc8.readthedocs.io/ |
| Licence | Apache-2.0 |
| Archive source | https://files.pythonhosted.org/packages/92/91/88bb55225046a2ee9c2243d47346c78d2ed861c769168f451568625ad670/doc8-2.0.0.tar.gz |
| Dernière mise à jour | 2026-06-13T01:24:09+02:00 |
| Pulse | updated |
| Dépendances | python@3.14 |
| Bouteille | disponible (sur all) |
| post-install Homebrew | non défini |
| Service | aucun déclaré |
faits du registre
Détails de la base source
| 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 |
|
piste source
Généré depuis les données du dépôt
Cette page est servie par av-web depuis l'artéfact SQLite privé des paquets généré par scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Sources utilisées
- 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