sphinxを使ってドキュメントをコードから自動生成する。

コードからドキュメントから自動生成するには以下のコマンドを入力すれば良い。

sphinx-apidoc -F -o docs/ path/to/your/library

あとは

cd docs
make html
open _build/html

とすればドキュメンテーションがちゃんと読める。

これを使って自分がよく使うライブラリのドキュメントはdocs以下のディレクトリに一元化しておくとかすると メリットがありそうなので早速やってみる。

Related Contents

Pickup Contents