DjangoのdocstringやらなんやらをSphinxで吐き出してもらう

Python 始めました。

割と小ネタです… だいぶ初歩的な部分で詰まっていたので書きます。

目的

• Djangoで書かれたプロジェクトの開発者向けのドキュメントを用意したい

やり方

コマンドライン上で下記をとりあえず実行

sphinx-apidoc -fF -o path/to/docs path/to/source '

そこで、path/to/docsの中にできたconf.pyの

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

を、下記のように書き換える

sys.path.insert(0, os.path.abspath('../../path/to/source'))
from django.conf import settings
settings.configure()

その後、下記を実行

sphinx-build -a -b html path/to/docs path/to/docs/html '

そうするとpath/to/docs/htmlにいい感じのドキュメントができる(っぽい)

参考サイト

Sphinxの最初の一歩 — Sphinx 1.3.2 ドキュメント

www.marinamele.com