将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文档，你只需要一个'vanilla'网络服务器设置即可。

此外，如果您坚持使用Django，这可能有助于Django urls straight to html template ...但是，我再次投票选择在您的根目录下设置/ docs目录，并通过基本Apache /将其指向sphinx数据NGINX / etc config。