python-sphinx
autodocを使ってドキュメントストリングを書く
サーチ…
前書き
Sphinxでは、パッケージに同梱されているautodoc拡張機能を使用してドキュメントにドキュメントストリングを含めることができます。このドキュメントでは、ドキュメンテーション文字列の書式設定方法を説明します。
autodoc拡張機能のインストール
あなたのドキュメントのルートにあるconf.pyファイルにあるextensionsモジュールlist autodocモジュールを追加してください：
extensions = [
'sphinx.ext.autodoc',
...
]
sphinxの設定でコードパスを追加する
Autodocはモジュールをインポートする必要があります。
conf.pyファイルにコードパスを含めることができます。
例えば：
import os
sys.path.insert(0, os.path.abspath('../src'))
Modified text is an extract of the original Stack Overflow Documentation
ライセンスを受けた CC BY-SA 3.0
所属していない Stack Overflow