将 Sphinx 文档与 django 集成答案

【问题标题】：Integrating Sphinx Documentation with django将 Sphinx 文档与 django 集成
【发布时间】：2013-10-08 09:24:44
【问题描述】：

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

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

我做到了。 django-sphinxdoc 本来是完美的，只是我正在处理一个旧的 django 项目。与某些 django-sphinxdoc 依赖项不兼容。符号链接工作得很好。我把它连接到管理界面。客户很高兴:)

【解决方案2】：

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

此外，如果您坚持使用 Django，这可能会有所帮助 Django urls straight to html template...但我再次投票决定在您的根目录下设置一个 /docs 目录，并通过基本的 Apache/NGINX/ 将其指向 sphinx 数据等配置。

【讨论】：

我的项目根目录中有 docs/。 /project/docs ...是否有您知道我可以为 nginx 配置的教程，以便我可以将 sphinx 数据指向？谢谢:)