ml-tooling/lazydocs

これは何？

主な機能

• 01GoogleスタイルのPython docstringからMarkdown形式のAPIドキュメントを生成します。
• 02ファイルパスと行番号を含むソースコードへのリンクを作成します。
• 03モジュール、クラス、関数を一覧にしたAPI概要ファイルを生成します。
• 04MkDocsサイトやGitHubで表示されるMarkdownと連携します。
• 05任意で、生成前にpydocstyleを使ってdocstringを検証できます。

ユースケース

• GitHubリポジトリにPythonライブラリのAPIリファレンスを公開する。
• MkDocsのドキュメントサイトに自動生成のAPIリファレンスセクションを追加する。
• モジュールの開発中に、docstringをもとにしたドキュメントをコンソールへ出力する。

クイックスタート

1. 1

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

   pip install lazydocs
2. 2

   PythonパッケージのMarkdownドキュメントを生成する

   lazydocs path/to/your/package

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

• !GoogleスタイルのPython docstringのみをサポートします。

収録されている特集

トピック

よくある質問

lazydocs とは？

Sphinxより軽量な、GoogleスタイルのPython docstringからMarkdown形式のAPIドキュメントを生成するCLIツール。 LazydocsはPythonのパッケージ、モジュール、または指定したクラスや関数をスキャンし、GoogleスタイルのdocstringをもとにMarkdown形式のドキュメントを生成します。コマンドラインから単一のコマンドで実行できるほか、Pythonからプログラム用APIを呼び出して利用できます。出力先はデフォルトで./docsフォルダーですが、標準出力への出力も可能です。

lazydocs は無料で使えますか？ライセンスは？

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

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

活発にメンテナンス中。lazydocs の最終コミットは 2026年10月23日 です。

lazydocs は何に使えますか？

GitHubリポジトリにPythonライブラリのAPIリファレンスを公開する。 MkDocsのドキュメントサイトに自動生成のAPIリファレンスセクションを追加する。 モジュールの開発中に、docstringをもとにしたドキュメントをコンソールへ出力する。

lazydocs のインストール方法は？

PyPIからlazydocsをインストールする: pip install lazydocs PythonパッケージのMarkdownドキュメントを生成する: lazydocs path/to/your/package

lazydocs はどこで入手できますか？

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