将sphinx文档与django集成

Question

我已经为django项目创建了sphinx文档。它创建了一个build文件夹一个html文件夹和一个index.html文件。我不确定的是如何将index.html文件集成到我的项目中。是否有可能简单地将其添加到URL配置，如果它将如何格式化？

Answer 1

IMO，做这件事的'最好的'方法就是在HTTP服务器级别，而不是在Django本身（至少我过去是这样做的）。您不需要或不需要任何Django图层来提供您的狮身人面像文档，您只需要一个“vanilla”web服务器设置即可完成此操作。

此外，如果你坚持使用Django，这可能会有所帮助Django urls straight to html template ......但是，我会投票选择在你的根目录下设置一个/ docs目录，并通过基本的Apache/NGINX/etc指向它的sphinx数据配置。

Answer 2

有一些较好的用例斯芬克斯doc的纳入的Django：

• 允许文档内动态内容（即用户登录，当前时间等）。
• 将文档与整体站点地图相集成。
• 只能创建和维护一组模板/ CSS文件。

如果您有一个或多个需求，我会看看django-sphinxdoc，它可以处理所有基本用例，但可以轻松修改。