Pythonパッケージのユーザー向けドキュメントを書く#
このセクションでは、Python パッケージのドキュメント作成のベストプラクティスを説明します。
ドキュメントに追加することを検討すべき要素、ドキュメントを読む可能性のあるさまざまなタイプのユーザー、パッケージのチュートリアルを作成する方法について話します。
ここでは、ドキュメンテーションを容易にするために使用できるsphinxの拡張機能についても説明します:
autodocは、あなたのコードの関数、クラス、メソッド、属性(APIドキュメント)のドキュメントを自動生成します。
チュートリアルのためのsphinxギャラリー。