Hosting Private Sphinx Documentation

Question

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.

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.

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?

Any options would be much appreciated.

I felt the same need to host documentation privately. So I have built a web service that supports private Sphinx documentation hosting: HasDocs. https://github.com/narrowcast/hasdocs.com It should eliminate the need to set up your own web server, etc. You can sync your GitHub repositories and permissions. Private projects have private docs that are accessible only by those with the right privileges. The documentation gets rebuilt whenever you push new code to your GitHub repository. It's currently in beta and supports Sphinx, Jekyll, and Javadoc as documentation generator. Please give it a try — yoonchee, Jan 21 '13 at 02:30

score 20 · Accepted Answer · answered Jun 19 '12 at 18:12

20

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.

answered Jun 19 '12 at 18:12

David Wolever

148,955
89
346
502

Does this work with the js search? – Darwin Tech Jun 19 '12 at 22:17
3

Yup. The JS search is just JS with a static index (which is built when you build your documentation). – David Wolever Jun 20 '12 at 00:15

ic_fl2 · Answer 2 · 2017-09-27T06:11:18.143

0

See the answer to this question (full disclosure, I asked the question, got no answer did some research and coding and posted the answer, so while it works there may be better ones out there. I'd be much obliged if someone would point them out.)

This gitlab repo shows a working example here.

Uses static password protection and is also discussed in this issue.

edited Sep 27 '17 at 06:11

answered Sep 26 '17 at 19:17

ic_fl2

831
9
29

Hosting Private Sphinx Documentation

2 Answers2

Linked