autodoc

python モジュールから docstring を抜き出してドキュメント化する。 sphinx-apidoc コマンド で rst を生成できる。

• https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

  • https://autoapi.readthedocs.io/

設定

conf.py に設定が必要

# todo
sys.path.append(PATH_TO_IMPORT_MODULE) # sphinx が import して docstring を生成するのに必要(対象が sys.path に含まれない場合)

extensinos = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon', # docstring syle 拡張(google 書式, numpy 書式)
]
# 設定
autodoc_default_options = {
    'member-order': 'bysource',
}

docstring

• https://www.python.org/dev/peps/pep-0257/

• Python入門］docstringの書き方

docstring の style

• GoogleスタイルのPython Docstringの入門

• https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

• https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html