【问题标题】：Sphinx autodoc with Django 1.4带有 Django 1.4 的 Sphinx 自动文档
【发布时间】：2012-10-19 01:27:35
【问题描述】：
我在为 Django 1.4.1 项目构建模块自动文档时遇到问题。 make html 似乎无法读取我的文档字符串，因为它在导入我的设置时遇到了问题。我见过的所有在线指南都建议使用
import settings
from django.core.management import setup_environ
setup_environ(settings)
但这在 1.4 中已被弃用，settings.configure() 方法似乎不合适。我还没有找到关于如何在 1.4 中运行的信息。我尝试设置DJANGO_SETTINGS，但没有运气。有什么建议吗？
【问题讨论】：
标签：
python
django
python-sphinx
autodoc
【解决方案1】：
问题似乎是我错误地设置了DJANGO_SETTINGS 环境变量，而我需要设置DJANGO_SETTINGS_MODULE。
所以，要明确一点，因为这个信息没有特别好记录，有两种等效的方法可以用 Django 1.4+ 设置自动文档：
-
运行前设置环境变量make html:
export PYTHONPATH=<path to root of source>
export DJANGO_SETTINGS_MODULE=myproject.settings
-
在conf.py中做同样的事情：
sys.path.append('<path to root of source>')
os.environ['DJANGO_SETTINGS_MODULE'] = 'myproject.settings'
我更喜欢后者，因为我可以在配置中设置它，并且文档将构建在任何部署中。