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

Project details


Release history Release notifications | RSS feed

This version

1.5.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-1.5.5.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

Sphinx-1.5.5-py2.py3-none-any.whl (1.6 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.5.5.tar.gz
Algorithm Hash digest
SHA256 4064ea6c56feeb268838cb8fbbee507d0c3d5d92fa63a7df935a916b52c9e2f5
MD5 f9581b3556df9722143c47290273bcf8
BLAKE2b-256 64789d63754981e97c8e7cf14500d262fc573145624d4c765d5047f58e3fdf4e

See more details on using hashes here.

File details

Details for the file Sphinx-1.5.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.5.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 11f271e7a9398385ed730e90f0bb41dc3815294bdcd395b46ed2d033bc2e7d87
MD5 4ea20f806be341504a1afe784d64d7cd
BLAKE2b-256 5e66760dc216df24dc890dc87741631af02f81659105d970a30e5a80c6c8cf75

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