Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx! HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text. Semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information. Easy definition of a document tree, with automatic links to siblings, parents and children. General index as well as a language-specific module index. Automatic highlighting using the Pygments highlighter. Automatic testing of code snippets, the inclusion of docstrings from Python modules (API docs), and more.
Features
- Sphinx uses reStructuredText as its markup language
- Its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils
- Links to documentation generated with Sphinx can be found on the Projects using Sphinx page
- Dozens of extensions contributed by users
- General index as well as a language-specific module indices
- Automatic highlighting using the Pygments highlighter
Project Samples
