adamchainz/blacken-docs

これは何？

主な機能

• 01MarkdownおよびreStructuredTextファイル内のpythonとpyconブロックを整形
• 02LaTeXドキュメント内のmintedおよびPythonTeXコードブロックに対応
• 03Pythonのdocstring内にあるMarkdownおよびreSTのコード例を整形し直す
• 04--checkモードを備え、ファイルに変更があった場合はゼロ以外の終了コードを返す
• 05Blackのバージョンを固定して使えるpre-commitフックを提供

ユースケース

• プロジェクトのREADMEやMarkdownドキュメント内にあるPythonスニペットの書式を統一する
• SphinxベースのreStructuredTextドキュメント内のコード例の書式を徹底する
• 変更をマージする前に、CIやpre-commitでドキュメントの整形チェックを実行する

クイックスタート

1. 1

   pip で blacken-docs をインストールする

   python -m pip install blacken-docs
2. 2

   ドキュメントファイルに blacken-docs を実行する

   blacken-docs README.rst

使う前に知っておきたいこと

• !Markdown、reStructuredText、LaTeX ファイル内の Python コードブロックのみをフォーマットします。
• !ディレクトリを再帰的に処理しません。ファイル名を指定するか、glob パターンまたは pre-commit を使用してください。

収録されている特集

トピック

よくある質問

blacken-docs とは？

Markdown、reStructuredText、LaTeXのドキュメント内にあるPythonコードブロックにBlackを実行するコマンドラインツール。 blacken-docsは、ドキュメントに埋め込まれたPythonコード例を整形し、プロジェクト内のほかのコードと書式を統一します。MarkdownとreStructuredTextのpythonおよびpyconブロック、LaTeXのmintedおよびPythonTeXブロックに対応し、Pythonのdocstring内にあるMarkdownやreSTも処理します。

blacken-docs は無料で使えますか？ライセンスは？

blacken-docs は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

blacken-docs は今もメンテナンスされていますか？

活発にメンテナンス中。blacken-docs の最終コミットは 2026年11月4日 です。

blacken-docs は何に使えますか？

プロジェクトのREADMEやMarkdownドキュメント内にあるPythonスニペットの書式を統一する SphinxベースのreStructuredTextドキュメント内のコード例の書式を徹底する 変更をマージする前に、CIやpre-commitでドキュメントの整形チェックを実行する

blacken-docs のインストール方法は？

pip で blacken-docs をインストールする: python -m pip install blacken-docs ドキュメントファイルに blacken-docs を実行する: blacken-docs README.rst

blacken-docs はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/adamchainz/blacken-docs