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

A development egg can be found here.

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.1.3.tar.gz (2.6 MB view details)

Uploaded Source

Built Distributions

Sphinx-1.1.3-py2.7.egg (1.4 MB view details)

Uploaded Egg

Sphinx-1.1.3-py2.6.egg (1.4 MB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.1.3.tar.gz
Algorithm Hash digest
SHA256 34dc95b70a2b07a61b5d61034c34b05f82514aab54ad27adedb49cee911bb8e9
MD5 8f55a6d4f87fc6d528120c5d1f983e98
BLAKE2b-256 bf1c973ec525f2743f14e1c1f528e4ddb8aa5f2a0ab7d39a0b3d14953f4a87de

See more details on using hashes here.

File details

Details for the file Sphinx-1.1.3-py2.7.egg.

File metadata

  • Download URL: Sphinx-1.1.3-py2.7.egg
  • Upload date:
  • Size: 1.4 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.1.3-py2.7.egg
Algorithm Hash digest
SHA256 05b2259276732ca1eb1e7c813635431fdb025c120493f1c5a2fb88c63b54d9e2
MD5 83ee00b4f709d9597fc59a2dd673ee03
BLAKE2b-256 c6491a5c854ed931044fcea66036c8003ec5fe250c706db790e61f3f52827390

See more details on using hashes here.

File details

Details for the file Sphinx-1.1.3-py2.6.egg.

File metadata

  • Download URL: Sphinx-1.1.3-py2.6.egg
  • Upload date:
  • Size: 1.4 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.1.3-py2.6.egg
Algorithm Hash digest
SHA256 85fe4e496bde00a7683be736e96e2803cca54d0e45f9fdb52f47a3d4d09a722e
MD5 f0873b56630070f661ec3abc3eaf4457
BLAKE2b-256 5320b130e18758d4d5f4851b4d47b7bb535fd693d3598b21607a943883ef812c

See more details on using hashes here.

Supported by

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