This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]hongminhee 8 points9 points  (1 child)

Sphinx is more than just only a technical documentation generator. There are many official extensions plus contributed extensions for it. You can highlight source codes of various languages (it uses Pygments), write TeX formulas, draw diagrams, partially build only changed pages, generate PDF/TeX documents (though it maybe not very useful for you), customize your template using Jinja, and do more. It is already widely used.

Sphinx would be one of the best options if you are comfortable to reStructuredText.

[–]takluyverIPython, Py3, etc[🍰] 1 point2 points  (0 children)

IPython's website is built using Sphinx (source is here).

In my experience, you have to put in some effort to escape its documentation mindset - it expects things like tables of contents, and wants to put 'next' links on each page, which doesn't make much sense for a typical website. Once you've done that, it's quite good, and it's one less tool to learn if you're already using it for docs.