Repolode
投稿する
pdoc3

pdoc3/pdoc

特別な設定なしで、モジュール、パッケージ、docstringからPython 3プロジェクトのAPIドキュメントを自動生成します。

GitHub で見る公式サイト
スター
1,187
フォーク
146
未解決の Issue
111
最終コミット
3 か月前

これは何？

pdocは、PythonプロジェクトのHTML APIドキュメントを生成するコマンドラインツールです。モジュールのファイル、パッケージのディレクトリ、またはimport pathを指定すると、公開オブジェクトをdocstringや型注釈とともに出力します。

Markdown、numpydoc、Google形式など一般的なdocstringスタイルに対応し、LaTeX数式や一部のreSTディレクティブもサポートします。また、__all__が定義されている場合はその内容を尊重します。オーバーライドされたクラスメンバーのdocstringが指定されていない場合は、基底のdocstringを継承します。モジュール、クラス、インスタンスの変数はASTをたどってドキュメント化されます。識別子間のリンクも自動で生成します。

テンプレートで出力をカスタマイズでき、モジュールレベルの__pdoc__辞書でdocstringを上書きできます。内蔵の開発用Webサーバーでは、編集しながら生成されたドキュメントをプレビューできます。

主な機能

  • 01モジュール、パッケージのディレクトリ、またはimport pathからHTMLドキュメントを生成します。
  • 02Markdown、numpydoc、Google形式のdocstringに対応します。
  • 03PEP 484およびPEP 526の型注釈を処理します。
  • 04オーバーライドされたクラスメンバーのdocstringを継承します。
  • 05参照されている識別子へのリンクを自動生成します。
  • 06カスタムテンプレートと内蔵のライブプレビューサーバーを利用できます。

ユースケース

  • PythonライブラリのAPIリファレンスを公開する。
  • 特別な設定なしで、社内Pythonパッケージの閲覧可能なドキュメントを生成する。
  • ドキュメントを執筆しながらdocstringのレンダリングをプレビューする。

クイックスタート

  1. 1

    PyPIからpdoc3をインストールする

    pip install pdoc3
  2. 2

    プロジェクトのドキュメントを生成する

    pdoc your_project

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

  • PyPIパッケージの名前はpdocではなくpdoc3です。pdoc3という名前でインストールしてください。
  • AGPL-3.0ライセンスで提供されています。強いコピーレフトライセンスのため、クローズドソースのプロジェクトでの使用が制限される場合があります。

収録されている特集

静的サイトジェネレーターとドキュメントツール

トピック

#python#api-documentation#documentation-generator#docstring#docs#docs-generator#docstring-documentation#docstrings#documentation#documentation-dumper

よくある質問

pdoc とは？
特別な設定なしで、モジュール、パッケージ、docstringからPython 3プロジェクトのAPIドキュメントを自動生成します。 pdocは、PythonプロジェクトのHTML APIドキュメントを生成するコマンドラインツールです。モジュールのファイル、パッケージのディレクトリ、またはimport pathを指定すると、公開オブジェクトをdocstringや型注釈とともに出力します。
pdoc は無料で使えますか？ライセンスは？
pdoc は AGPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
pdoc は今もメンテナンスされていますか？
半年以内に更新あり。pdoc の最終コミットは 2026年8月15日 です。
pdoc は何に使えますか？
PythonライブラリのAPIリファレンスを公開する。 特別な設定なしで、社内Pythonパッケージの閲覧可能なドキュメントを生成する。 ドキュメントを執筆しながらdocstringのレンダリングをプレビューする。
pdoc のインストール方法は？
PyPIからpdoc3をインストールする: pip install pdoc3 プロジェクトのドキュメントを生成する: pdoc your_project
pdoc はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/pdoc3/pdoc

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト