python - Sphinx 自动文档与 Django 1.4

Question

我在为 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，但没有成功。有什么建议吗？

Answer 1

问题似乎是当我需要设置 DJANGO_SETTINGS_MODULE 时，我错误地设置了 DJANGO_SETTINGS 环境变量。

所以，需要明确的是，由于此信息没有特别详细的记录，因此有两种等效的方法可以使用 Django 1.4+ 设置自动文档:

1. 在运行 make html 之前设置环境变量:

   export PYTHONPATH=<path to root of source>
   export DJANGO_SETTINGS_MODULE=myproject.settings
   

2. 在 conf.py 中执行等效操作:

   sys.path.append('<path to root of source>')
   os.environ['DJANGO_SETTINGS_MODULE'] = 'myproject.settings'
   

我更喜欢后者，因为我可以在配置中设置它，并且文档将在任何部署中构建。