Skip to main content

Python documentation generator

Project description

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned.

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.

Among its features are the following:

  • Output formats: HTML (including derivative formats such as HTML Help, Epub and Qt Help), plain text, manual pages and LaTeX or direct PDF output using rst2pdf

  • Extensive cross-references: semantic markup and automatic links for functions, classes, 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 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 snippets and inclusion of appropriately formatted docstrings

  • Setuptools integration

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Sphinx-1.4.6.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

Sphinx-1.4.6-py2.py3-none-any.whl (1.6 MB view details)

Uploaded Python 2Python 3

File details

Details for the file Sphinx-1.4.6.tar.gz.

File metadata

  • Download URL: Sphinx-1.4.6.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.4.6.tar.gz
Algorithm Hash digest
SHA256 9e43430aa9b491ecd86302a1320edb8977da624f63422d494257eab2541a79d3
MD5 e86658823b51296dbe6ebff5f58988c9
BLAKE2b-256 557775d85633ae923006d6942cc16cf11ba2cbd6c3bd3cac5de029c46aa04afe

See more details on using hashes here.

File details

Details for the file Sphinx-1.4.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.4.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ca21acab510fe7959323ec1bda1d9bbb0774c1cda6eae820c11037c79cb23d71
MD5 803413747ae66a09155db45958474cd0
BLAKE2b-256 c72dac514086b870f6f952b80f49ff550e638b41d6d678349a36b23e88b64fdc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page