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

This version

0.4.1

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

Uploaded Source

Built Distributions

Sphinx-0.4.1-py2.5.egg (343.6 kB view details)

Uploaded Egg

Sphinx-0.4.1-py2.4.egg (347.5 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.4.1.tar.gz
Algorithm Hash digest
SHA256 9a54c1513cac421d907959a4f09aada93d69850d3eea640e77de5b2ebff77f8a
MD5 45eba5dcfc909241c7bce9d9bf96f2af
BLAKE2b-256 ee1fd692407d577b805fa0edda90b37db03f189f9fd1cc2668199d1e67d21a37

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.4.1-py2.5.egg
Algorithm Hash digest
SHA256 b49a4071bc065babd196b74b1b3aff4e3fad959387bd79208f67e7ea44a850f6
MD5 a56928df371c489819a7c13a0db6cd3b
BLAKE2b-256 d8a8d6a4f91650333086385953d05d10af7dd684ab73f0f32bfe89f0689b0ccc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-0.4.1-py2.4.egg
Algorithm Hash digest
SHA256 6e06c08ce27300149809026f48de19f6ee8f85ed82210b102f91ec83884792e3
MD5 3ed6e7a69a992427d090175f12f8cad0
BLAKE2b-256 1a60c15415d68ab3e6d2bcef8a13962065ff0a8972af8e8fa34e22bcdcdbb05a

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