如何为django项目构建sphinx文档
如何为django项目构建sphinx文档
提问于 2011-10-12 07:08:32
我有一个django项目，我在文档字符串中使用reST记录了该项目，以执行以下操作：
- 帮助稍后在集成开发环境
- 中进行诊断，以便使用Sphinx
生成HTML文档
我的文档可以在集成开发环境(PyCharm)中正确显示，但是我不能配置Sphinx为我生成HTML文档。
以下是我的项目的结构
+--------------------------------------------+
| /saassapp # django project path |
| /docs # dir for sphinx |
| conf.py # sphinx config file |
| ... |
| settings.py # django settings |
| /studyview # django app |
| ...
| ... |
+--------------------------------------------+有什么想法吗？检查一下conf.py文件会非常有用。谢谢。
编辑
我的项目名为saassapp，我正在尝试为其制作文档的模块名为studyview。
- Sphinx
- Sphinx
conf.py文件：http://pastebin.com/HTYdc1rR
- Sphinx
index文件：http://pastebin.com/bu1r38TQ
- Result of ：http://pastebin.com/MWJj94EE
回答 6
Stack Overflow用户
回答已采纳
发布于 2015-11-17 17:32:01
Django 1.7中引入的迁移特性阻止了以前的答案在新版本上工作。相反，您将不得不进行手动设置。与前面所有的答案类似，你首先必须确保Django可以找到你的设置，然后调用django.setup()，它将加载设置并设置你的模型。将其添加到Sphinx项目的conf.py中
os.environ['DJANGO_SETTINGS_MODULE'] = 'projectname.settings'
import django
django.setup()Stack Overflow用户
发布于 2011-11-20 01:16:25
将以下内容添加到您的conf.py中，您将不需要每次都设置DJANGO_SETTINGS_MODULE：
import sys, os
sys.path.append('/path/to/your/project') # The directory that contains settings.py
# Set up the Django settings/environment
from django.core.management import setup_environ
from myproject import settings
setup_environ(settings)Stack Overflow用户
发布于 2014-06-23 23:23:21
在Django1.6中，我不能使用@MikeRyan的答案，因为from django.core.management import setup_environ已经被弃用了。相反，我转到我的conf.py文件并添加了以下内容：
import sys
import os
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
os.environ['DJANGO_SETTINGS_MODULE'] = 'dataentry.settings'
from django.conf import settings让我解释一下每一行：
- 我使用了相对路径(向上两个目录)，但如果您想要
- 我的项目名称是
dataentry，并且settings.py文件在该文件夹中，则可以继续放置绝对路径；将名称(数据条目)更改为项目名称
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/7733577
复制相关文章
相似问题
腾讯云开发者
