托管私人 Sphinx 文档 [关闭]答案

【问题标题】：Hosting Private Sphinx Documentation [closed]托管私人 Sphinx 文档 [关闭]
【发布时间】：2012-06-19 17:50:36
【问题描述】：

我目前正在为一个相当复杂的 Django 网站使用 Sphinx 编写一些广泛的文档。我一直在内部进行此工作，在我即将离开之前，我想留下可供新开发人员/管理员访问该站点的详细文档。

我的问题是托管此文档的选项有哪些？我宁愿它是私人的。文档还涉及网站而不是 python 包。由于这两个原因，我认为阅读文档可能不是最合适的选择。

我遇到了 django-sphinxdoc ，尽管这需要将 Haystack 设置为后端。有没有办法使用内置的 js 搜索简单地为文档提供服务？还是允许私人托管文档的服务？

任何选项将不胜感激。

【问题讨论】：

我觉得同样需要私下托管文档。因此，我构建了一个支持私有 Sphinx 文档托管的 Web 服务：HasDocs。 github.com/narrowcast/hasdocs.com 它应该消除设置您自己的网络服务器等的需要。您可以同步您的 GitHub 存储库和权限。私有项目有私有文档，只有具有正确权限的人才能访问。每当您将新代码推送到 GitHub 存储库时，文档都会重新构建。它目前处于测试阶段，支持 Sphinx、Jekyll 和 Javadoc 作为文档生成器。请试一试

【解决方案1】：

Sphinx 可以生成静态的.html 文件（make html）。将这些 HTML 文件放在内部 Web 服务器上，您应该可以开始使用了。

【讨论】：

【解决方案2】：

查看question 的答案（完全披露，我问了这个问题，没有得到答案，做了一些研究和编码并发布了答案，所以虽然它有效，但可能会有更好的答案。我会很多如果有人能指出来，我们将不胜感激。）

这个 gitlab repo 展示了一个工作示例 here。

使用static password protection，并在此issue 中进行了讨论。

【讨论】：