doc8 for Mac 版
Sphinx 文档的样式检查器
doc8 是什么
doc8 是一个针对 reStructuredText(并对纯文本提供基础支持)的文档风格检查工具,由 PyCQA 维护。它按照一套明确的规则扫描文档目录,检查格式与风格问题,比如 RST 语法是否合法、行宽是否超过 79 字符、行尾是否有多余空白、是否用制表符缩进、是否出现 Windows 换行符、文件末尾是否缺少换行等,每类问题对应一个错误码,便于定位和忽略。它还会对 Sphinx 场景下容易误报的情况做处理,并允许通过配置调整行为,例如放宽长标题限制、指定忽略的错误码或路径、设置默认文件扩展名和编码、自定义最大行长度等。doc8 解决的是文档写作中风格不统一、细节错误难以人工排查的问题,适合用 RST 编写文档的 Python 项目,尤其是使用 Sphinx 生成文档、希望在 CI 中自动把关文档质量的团队。
如何安装 doc8
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2025-06-13,当前版本 v2.0.0,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| v2.0.0 | 2025-06-13 | 稳定版 | — | — | — | — |
| v1.1.2 | 2024-09-02 | 稳定版 | — | — | — | — |
| v1.1.1 | 2022-12-24 | 稳定版 | — | — | — | — |
| v1.0.0 | 2022-07-27 | 稳定版 | — | — | — | — |
| 0.11.2 | 2022-05-17 | 稳定版 | — | — | — | — |
| 0.11.1 | 2022-03-31 | 稳定版 | — | — | — | — |
| 0.11.0 | 2022-03-30 | 稳定版 | — | — | — | — |
| 0.10.1 | 2021-11-10 | 稳定版 | — | — | — | — |
| 0.9.1 | 2021-09-27 | 稳定版 | — | — | — | — |
| 0.9.0 | 2021-07-19 | 稳定版 | — | — | — | — |
数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- all
⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| doc8 | v2.0.0 | Apache-2.0 | 命令行 | 8 |
| argtable3 | v3.3.1 | BSD-3-Clause | 命令行 | 10 |
| gi-docgen | 2026.1 | Apache-2.0 OR GPL-3.0-or-later | 命令行 | 11 |
| pkgsite | 0.6.0 | BSD-3-Clause | 命令行 | 9 |
命令行工具中的类似应用
argtable3
Argtable3 是一个开源的 ANSI C 库,用来简化 GNU 风格命令行选项的解析。gi-docgen
gi-docgen 是一款面向 GObject 生态的文档生成工具,主要服务于使用 GNOME 技术栈开发库的开发者。pkgsite
这个仓库托管了 pkg.go.dev 网站的源码,以及 pkgsite 这个文档服务器程序。cweb
cweb 是 Donald Knuth 开发的文学编程工具 CWEB 的持续开发版本。openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。xz
XZ Utils 是一个通用数据压缩库,同时附带命令行工具。它的原生格式是 .xz,也兼容旧的 .lzma 格式。所属分类:命令行工具