托管私人Sphinx文档[关闭]

问题描述 投票:16回答:2

我目前正在使用Sphinx为一个相当复杂的Django网站编写一些大量文档。我一直在内部工作,在我很快离开之前,我想留下新的开发人员/管理员可以访问的详细文档。

我的问题是我有什么选择来托管这个文档?我希望它是私人的。文档也涉及网站而不是python包。出于这两个原因,我认为阅读文档可能不是最合适的选择。

我跑过django-sphinxdoc,虽然这需要设置Haystack作为后端。有没有办法简单地使用内置的js搜索服务器文档?或者允许私人托管文档的服务?

任何选项都将非常感激。

django python-sphinx
2个回答
15
投票

Sphinx可以生成静态.html文件(make html)。将这些HTML文件放在内部Web服务器上,你应该很高兴。


0
投票

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

这个gitlab repo显示了一个工作示例here

使用static password protection,也在这个issue中讨论过。

© www.soinside.com 2019 - 2024. All rights reserved.