インストール

追加のインストールコマンド

macOS

Homebrew確認済み · 100%

brew install doc8

local 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	未記録
サービス	宣言なし

パッケージグラフ

リンクは、ローカルのパッケージ関係グラフ、補足データ、依存関係、エコシステム一致、パッケージハブ所属から来ています。

ソース経路

リポジトリデータから生成

このページは scripts/generate-pkg-sqlite.py が生成した非公開のパッケージ SQLite アーティファクトから av-web によって提供されます。

Combined YAML source

View the package source record on GitHub.

combined/doc8.yml

使用ソース

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

doc8 を Homebrew でインストール