Software Finder

Find TU Delft software or third-party apps for research, work or study
Back to list

Sphinx

Python documentation generator

Functionality

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 Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI

Help & Getting started

You can find tutorials here

Cost

Free

Terms of use

Sphinx is licensed under BSD license. You can find the Code of Conduct here

Privacy/Security Status

Grey


Platform

  • Linux
  • Mac
  • Windows

Where to find

You can download Sphinx here