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.3

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

Uploaded Source

Built Distributions

Sphinx-0.6.3-py2.6.egg (653.8 kB view details)

Uploaded Egg

Sphinx-0.6.3-py2.5.egg (654.4 kB view details)

Uploaded Egg

Sphinx-0.6.3-py2.4.egg (661.3 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.3.tar.gz
Algorithm Hash digest
SHA256 7da3fb1fec3fc61073e1432a5c2698a02bf8a8370963725816afc429d7d468ba
MD5 b8ba063eeeaf818a7ea07fd28d9614a9
BLAKE2b-256 99cd6fde7dd784759d649ed5d2c66b021fdc7749cdd04ca3ee8599cad3e1357d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.3-py2.6.egg
Algorithm Hash digest
SHA256 7c62b3148fead7b878b203132a47bcd983fac68bb4a1a2dec7e1789e5ad01599
MD5 5a3e6f4b5d972eb38968f91bf232265d
BLAKE2b-256 d8a771fcf777d0a232cc211b8071a88c671a69bbb19b005c0d23095e6588fe77

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.3-py2.5.egg
Algorithm Hash digest
SHA256 50043936416bb2631ad52221041b4b0bcee10291643fc3a58588ba2bedf46281
MD5 e6af92a03efb5409b5200f94c2690962
BLAKE2b-256 51c4e2126bcf9e90f979283b3786f81e0b0441fcf40e5077e09e756fc0c87555

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.6.3-py2.4.egg
Algorithm Hash digest
SHA256 88a99a52555215ac008ab1516c168e2ea1bf1c7b268df5672bb79685f4daa5c9
MD5 4a1a2499e55f73937a1e28313135dda0
BLAKE2b-256 69d87e3b00de26870b5cbefbe74fa729e26e763294875b662fc58cbf73aca565

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