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

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.5.4.tar.gz
Algorithm Hash digest
SHA256 0ae4f247e6433beaf38473e37bea44d5b3b87bd6d57d8a9f627d81c9a1be1120
MD5 b4c2b44259cf113e953e7d3603153c5f
BLAKE2b-256 c8c87abbccf8276b7e2a02f416198ade475c5d7f79be7f817abc4cb5f3ba0044

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.5.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 262509f9ec6a08fd3734fc3408bc60064226787d0aa39271898606719450e9d4
MD5 ec943e4e316bcada0412ebc4bc38818b
BLAKE2b-256 64cd2187f5af609eda0e08f3758c3814405f4a87a93f2252d3201b94a6330279

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