托管私人Sphinx文档 [英] Hosting Private Sphinx Documentation

问题描述

我目前正在使用Sphinx为一个相当复杂的Django网站编写一些详尽的文档。我一直在内部进行这项工作，不久之后，我想留下该站点的新开发人员/管理员可以访问的详细文档。

I am currently writing some extensive documentation using Sphinx for a rather complex Django web site. I have been working on this in-house and before I leave soon I want to leave behind detailed documentation accessible by the new devs/admins for the site.

我的问题是托管此文档有哪些选择？我希望它是私有的。此外，文档所涉及的网站不是python软件包。由于这两个原因，我认为阅读文档可能不是最合适的选择。

My question is what are my options for hosting this documentation? I would prefer it to be private. Also the docs are concerning a website not a python package. For these two reasons I am thinking that Read the Docs may not be the most appropriate option.

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

I ran across django-sphinxdoc , though this requires setting up Haystack as the backend. Is there not a way to simply server the docs using the built in js search? Or a service which allows private hosting of the docs?

任何选项将不胜感激。

推荐答案

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

Sphinx can generate static .html files (make html). Put those HTML files up on an internal web server and you should be good to go.

这篇关于托管私人Sphinx文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！