Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Hosting Private Sphinx Documentation [closed]

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.

like image 884
Darwin Tech Avatar asked Jun 19 '12 17:06

Darwin Tech


People also ask

Does Sphinx support markdown?

To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.


1 Answers

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.

like image 155
David Wolever Avatar answered Nov 07 '22 05:11

David Wolever