django - 将 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 文档提供服务，您只需要一个“香草”网络服务器设置即可。

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