Repository files navigation

Sphinx is a tool that makes it easy to create intelligent and beautifuldocumentation for Python projects (or other documents consisting of multiplereStructuredText sources), written by Georg Brandl. It was originally createdfor the new Python documentation, and has excellent facilities for Pythonproject documentation, but C/C++ is supported as well, and more languages areplanned.

Sphinx uses reStructuredText as its markup language, and many of its strengthscome from the power and straightforwardness of reStructuredText and its parsingand translating suite, the Docutils.

Among its features are the following:

• Output formats: HTML (including derivative formats such as HTML Help, Epuband Qt Help), plain text, manual pages and LaTeX or direct PDF outputusing rst2pdf
• Extensive cross-references: semantic markup and automatic linksfor functions, classes, glossary terms and similar pieces of information
• Hierarchical structure: easy definition of a document tree, with automaticlinks to siblings, parents and children
• Automatic indices: general index as well as a module index
• Code handling: automatic highlighting using the Pygments highlighter
• Flexible HTML output using the Jinja 2 templating engine
• Various extensions are available, e.g. for automatic testing of snippetsand inclusion of appropriately formatted docstrings
• Setuptools integration

For more information, refer to thethe documentation.

Sphinx is published onPyPI and can be installed from there:

pip install -U sphinx

We also publish beta releases:

pip install -U --pre sphinx

If you wish to install Sphinx for development purposes, refer tothecontributors guide.

Documentation is available fromsphinx-doc.org.

• Report bugs, suggest features or view the source codeon GitHub.
• For less well defined questions or ideas, use themailing list.

Please adhere to ourcode of conduct.

Continuous testing is provided byTravis (for unit tests and style checkson Linux),AppVeyor (for unit tests on Windows), andCircleCI (forlarge processes like TeX compilation).

For information on running tests locally, refer tothe contributors guide.

Refer tothe contributors guide.

Releases are signed with following keys:

• 498D6B9E
• 5EBA0E07