macOS
Homebrew已验证 · 100%
brew install doc8local Homebrew formula metadata
安装
其他安装命令
概览
软件包摘要
Style checker for Sphinx documentation
项目链接
命令和别名
- doc8
历史
项目历史与用法
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.
项目历史
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 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.
使用方式
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.
为什么软件包爱好者会关心
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.
时间线
- 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.
来源
安全态势
风险级别：绿色
narrow executable package without higher-risk signals.
风险分类器
绿色 风险 · 低 置信度 · appliance
原因
- narrow executable package without higher-risk signals
信号
- metadata:no-higher-risk-signals
安装行为
- 未记录 Homebrew bottle 元数据。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
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
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
doc8 | 可执行文件 | 已索引可执行文件 | 从本地可执行文件索引发现。 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-08-03
管理器版本2.0.0
管理器更新时间2026-06-13
本地数据未知
上游不可用
检测到的最新版本未检测到
- OK没有生成新鲜度警告。
安装元数据
软件包元数据
| 软件包键 | brew:doc8 |
|---|---|
| 版本 | 2.0.0 |
| 软件包管理器 | Homebrew |
| 主页 | https://github.com/PyCQA/doc8 |
| 仓库 | https://github.com/PyCQA/doc8 |
| 最后更新 | 2026-06-13T01:24:09+02:00 |
| Pulse | updated |
| Bottle | 未记录 |
| 服务 | 未声明 |
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- 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