What is Sphinx?
Who uses Sphinx?
Why developers like Sphinx?
Here are some stack decisions, common use cases and reviews by companies and developers who chose Sphinx in their tech stack.
We use Sphinx as the main search indexing system on our clients' websites. It's a more powerful system than we even scratch the surface of, and allows us to index data from a variety of sources. Sphinx
We use Sphinx because it's the standard for Python documentation. As Paperless is Python-based, this only made sense.
Additionally, readthedocs.org plays very well with it, so that's your documentation hosting for you for free.
Finally, it supports ReStructuredText, which is amazingly powerful.
- Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
- Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
- Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
- Automatic indices: general index as well as a language-specific module indices
- Code handling: automatic highlighting using the Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more