What users say: “Cheers for a great tool that actually makes programmers want to write documentation!“
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! The following features should be highlighted:
Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
First steps with Sphinx overview of basic tasks Tutorial beginners tutorial Contents for a complete overview Search page search the documentation Changes release history General Index all functions, classes, terms
You can also download PDF/EPUB versions of the Sphinx documentation from pop up menu on lower right corner.
Links to documentation generated with Sphinx can be found on the Projects using Sphinx page. For examples of how Sphinx source files look, use the “Show source” links on all pages of the documentation apart from this welcome page.
You may also be interested in the very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers.
There is a translation team in Transifex of this documentation, thanks to the Sphinx document translators.
A Japanese book about Sphinx has been published by O'Reilly: Sphinxをはじめよう / Learning Sphinx.
In 2019 the second edition of a German book about Sphinx was published: Software-Dokumentation mit Sphinx.
If you want to contribute to the project, this part of the documentation is for you.
Code of Conduct
Please adhere to our Code of Conduct.