shphinxを使ってPythonのコードからAPIドキュメント作成

無駄に苦労したのでメモ

• shphinxのquick_start autodocはy
• 20行目あたり，conf.pyの以下のコメントアウトを外し、sys.path.insertの表記を[srcフォルダ] へのパスにする

前

# import sys
# import os

# sys.path.insert(0, os.path.abspath('.'))

後

import sys
import os

sys.path.insert(0, os.path.abspath('[srcDirectoryPath]'))

• extensionsの値を ["sphinx.ext.autodoc"]へ

• コマンドsphinx-apidoc -f -o [出力フォルダ] [srcフォルダ]

• index.rstの書換えmodulesの追加

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules 

• コマンドsphinx-build -b html [conf.pyのフォルダ] [ビルド先フォルダ]

おまけ

---

• ネット初期みたいなスタイルシートは、html_themeの値を変えることで簡単に変えられる。
  http://www.sphinx-doc.org/ja/stable/theming.html
  この時conf.pyからhtml_sidebars=～をコメントアウトする

• 出力オブジェクトの種類を決定するオプションは生成された*.rstに書き込む
  そしてautodoc_default_flagsは環境変数SPHINX_APIDOC_OPTIONSに書き込む（，区切り）

  https://github.com/sphinx-doc/sphinx/blob/master/sphinx/apidoc.py

というかここがわかりやすかったので参考

bonbonbe.hatenablog.com