17

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

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

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

任何选项将不胜感激。

4

2 回答 2

19

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

于 2012-06-19T18:12:48.827 回答
0

查看这个问题的答案(完全披露,我问了这个问题,没有答案做了一些研究和编码并发布了答案,所以虽然它有效,但可能会有更好的答案。如果有人指出,我将非常感激他们出去。)

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

使用静态密码保护并在本期中进行了讨论。

于 2017-09-26T19:17:55.507 回答