Repository files navigation

Sphinx makes it easy to create intelligent and beautiful documentation.

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.

• Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
• 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 highlighting: automatic highlighting using the Pygments highlighter
• Templating: Flexible HTML output using the Jinja 2 templating engine
• Extension ecosystem: Many extensions are available, for example forautomatic function documentation or working with Jupyter notebooks.
• Language Support: Python, C, C++, JavaScript, mathematics, and many otherlanguages through extensions.

For more information, refer tothe documentation.

The following command installs Sphinx from thePython Package Index. You willneed a working installation of Python and pip.

pip install -U sphinx

We appreciate all contributions! Refer tothe contributors guide forinformation.