Django で epydoc を使う方法

Django の python 版といえる epydoc を使う方法のまとめ。

単に

$ cd YOUR-DJANGO-PROJECT-DIR
$ epydoc ./

とすると

Error importing 'imgSeekWeb.admin.views': Environment variable DJANGO_SETTINGS_MODULE is undefined.
...
 
Warning: UID conflict detected: django.db.models.manipulators.AddManipulator.manager

といったエラーやワーニングが出てまともにドキュメントが生成されない。

そこで以下のようなファイル epydoc_start.py

#!/usr/bin/python
import settings
from django.core import management
management.setup_environ(settings)

from epydoc.cli import cli
cli()

を作り実行する。

$ cd YOUR-DJANGO-PROJECT-DIR
$ epydoc_start.py ./

実行後 html というディレクトリができ、
そこに epydoc で生成されたドキュメントが展開される。