Sphinxより軽量な、GoogleスタイルのPython docstringからMarkdown形式のAPIドキュメントを生成するCLIツール。
25342PythonMIT更新 16 日前
#docstring
これらのツールは Python のドキュストリングを扱い、API ドキュメントの生成、ドキュストリングの網羅率の計測、書式の統一を行います。生成、欠落の確認、整形のどれが必要かを先に決めるとよいでしょう。pdoc3/pdoc は特別な設定なしでモジュールやパッケージからドキュメントを生成しますが、AGPL-3.0 ライセンスのため商用利用では注意が必要です。econchick/interrogate は関数、クラス、モジュールの網羅率を測り、CI で合否のしきい値を設定できます。PyCQA/docformatter は PEP 257 に沿ってドキュストリングを整形します。
Sphinxより軽量な、GoogleスタイルのPython docstringからMarkdown形式のAPIドキュメントを生成するCLIツール。
NumPy形式のdocstringを解析し、構造化されたAPIドキュメントとして出力するSphinx拡張機能です。
PEP 257の規約に沿ってdocstringを自動整形するPython用コマンドラインツール。
コードベース内の関数、クラス、メソッド、モジュールのdocstring記述率を測定し、CI向けの合否しきい値を設定できるPython CLI。
特別な設定なしで、モジュール、パッケージ、docstringからPython 3プロジェクトのAPIドキュメントを自動生成します。