将Sphinx文档与django集成

Question

我为django项目创建了sphinx文档.它创建了一个构建文件夹,一个html文件夹和一个index.html文件.我不确定的是如何将index.html文件集成到我的项目中.是否可以简单地将其添加到url配置中,如果它将如何格式化？

Answer 1

将sphinx doc集成到Django中有一些很好的用例:

• 允许文档中的动态内容(即用户登录,当前时间等).
• 将文档与整个站点地图集成.
• 只能创建和维护一组模板/ CSS文件.

如果你有一个或多个这些需求,我会看看django-sphinxdoc,它可以处理所有基本用例,但可以轻松修改.

Answer 2

IMO，做到这一点的“最佳”方法只是在 HTTP 服务器级别，而不是在 Django 本身（至少我过去是这样做的）。您不需要或不希望 Django 层的任何部分来为您的 sphinx 文档提供服务，您只需要一个“普通”Web 服务器设置即可做到这一点。

另外，如果你坚持使用 Django，这可以帮助Django url 直接指向 html 模板...但是，我再次投票支持在你的根目录下设置一个 /docs 目录，并通过基本的 Apache/NGINX/ 将其指向 sphinx 数据等配置。