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), plain text 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.

A development egg can be found here.

Project details


Release history Release notifications | RSS feed

This version

0.6.5

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

Uploaded Source

Built Distributions

Sphinx-0.6.5-py2.6.egg (658.5 kB view details)

Uploaded Egg

Sphinx-0.6.5-py2.5.egg (659.0 kB view details)

Uploaded Egg

Sphinx-0.6.5-py2.4.egg (666.0 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.5.tar.gz
Algorithm Hash digest
SHA256 500d749251ff4d311a81714e2f8f184168e10262a3a0d55f04f22f89164329b7
MD5 86dd5dbd55cb44d1f8091a4a1c3743b2
BLAKE2b-256 05f71b2478ad3c79532c715e83c51591545abef1c6ee4d60ba16e82b7d664440

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-0.6.5-py2.6.egg
  • Upload date:
  • Size: 658.5 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.6.5-py2.6.egg
Algorithm Hash digest
SHA256 324023f750030abbfb12f68f307fd63ee0dcf1eaee14e3caa9c3dbd969a8abf3
MD5 d1230f6d317a35770365f62225069259
BLAKE2b-256 e6bdf2c3dc09f96f2e06ea908a04b004504c7031f57415f0c8a45ae8cc888289

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.5-py2.5.egg
Algorithm Hash digest
SHA256 6d7b26254bff6f1f33a0c2ddc5b4dd1c2accd9c918fdc258694a0c29fbf4198e
MD5 b172e22f617ad8a0d179a528c52812d8
BLAKE2b-256 abd545907754a447fdd13dd96316f91455374061bb9b400eb17f9038427bb245

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.5-py2.4.egg
Algorithm Hash digest
SHA256 f6e41b52e63029ec2018131b0115083a399000f990d97f1fae46af8e9f0696eb
MD5 a3128d88b4426daeb069e74bcec3476a
BLAKE2b-256 0cc9e3e608feae7d8433277bb514d92a7b1ca8ad2e053371d036ee5c92cf0270

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