# 使用 Homebrew 安装 doc8

查看 doc8 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。

## 安装

```sh
sudo av install brew:doc8
```

其他安装命令:

### macOS

- Homebrew (100%):

```sh
brew install doc8
```

  证据: local Homebrew formula metadata

## 软件包事实

- **软件包键:** brew:doc8
- **软件包管理器:** Homebrew
- **版本:** 2.0.0
- **来源摘要:** Style checker for Sphinx documentation
- **主页:** <https://github.com/PyCQA/doc8>
- **仓库:** <https://github.com/PyCQA/doc8>
- **最后更新:** 2026-06-13T01:24:09+02:00
- **已生成:** 2026-08-03T19:37:03+00:00

## 可执行文件

- doc8 (别名)

## 安装行为

- Bottle: 不可用

## 版本和新鲜度

- 页面生成时间: 2026-08-03
- 管理器版本: 2.0.0
## 项目历史与用法

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.

### 来源

- <https://pypi.org/project/doc8/>
- <https://pypi.org/project/doc8/0.3.5/>
- <https://github.com/PyCQA/doc8>
- <https://github.com/PyCQA/doc8/releases>
- <https://wiki.openstack.org/wiki/Infrastructure_Status>
- <https://doc8.readthedocs.io/>


## 安全说明

narrow executable package without higher-risk signals.

- **Geiger 风险:** 绿色 / 低
- 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

## Combined YAML source

View the package source record on GitHub. [combined/doc8.yml](https://github.com/mxcl/pkgdb/blob/main/combined/doc8.yml)


## 来源

- pkg.so package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph