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 to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects.

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.

Although it is still under constant development, the following features are already present, work fine and can be seen “in action” in the Python docs:

  • Output formats: HTML (including Windows HTML Help) and LaTeX, for printable PDF versions

  • 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

  • Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings.

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-0.1.61843.tar.gz (369.1 kB view details)

Uploaded Source

Built Distributions

Sphinx-0.1.61843-py2.5.egg (664.3 kB view details)

Uploaded Egg

Sphinx-0.1.61843-py2.4.egg (670.7 kB view details)

Uploaded Egg

File details

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

File metadata

  • Download URL: Sphinx-0.1.61843.tar.gz
  • Upload date:
  • Size: 369.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.1.61843.tar.gz
Algorithm Hash digest
SHA256 4b9831b7cad5acd23afa5a360bd470d1e5d2942972e84f7db763610a32e5c418
MD5 69ab7befe60af790d24e22b4b46e8392
BLAKE2b-256 aa36916d32d0cf1aef89583d99effe19b883d5f4e6f7b23861b8adfda31617e2

See more details on using hashes here.

File details

Details for the file Sphinx-0.1.61843-py2.5.egg.

File metadata

  • Download URL: Sphinx-0.1.61843-py2.5.egg
  • Upload date:
  • Size: 664.3 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.1.61843-py2.5.egg
Algorithm Hash digest
SHA256 42293eb2854928630d06298c80094dd9b5b60bd2b7cc3583c4b312899864cd89
MD5 607908a9693266fab3600a724961e0de
BLAKE2b-256 245ddea1bcba1523f69217e54a9de1bf190976a5593e843e8dc76f8764bc67cb

See more details on using hashes here.

File details

Details for the file Sphinx-0.1.61843-py2.4.egg.

File metadata

  • Download URL: Sphinx-0.1.61843-py2.4.egg
  • Upload date:
  • Size: 670.7 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.1.61843-py2.4.egg
Algorithm Hash digest
SHA256 50aed6c5fcfb55fd34f7108d29e0d35c9497886eae323cc9fac0557594b021ab
MD5 bd516211c5b5dabc002af66a5815af49
BLAKE2b-256 01ee54c86d9147145004c34e93995e8ec7fa2a7e0cd1c50706e3cc6d0aa145b9

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