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

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

Uploaded Source

Built Distribution

Sphinx-1.3.4-py2.py3-none-any.whl (1.5 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.3.4.tar.gz
Algorithm Hash digest
SHA256 8aacc3f34aa758751fdb44ab9238eab024c66b57d67200f9a35efebf0e368057
MD5 a0aa2e92d749d52c678873994dff9e10
BLAKE2b-256 01e17b1aca627ca94db96c5e030e2df4e38dcca87aa9bc53c56075ff827a0823

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.3.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1b74cb9cf26c2a0bc22e6012f7e6003d101f79eab024e7e32f9346eedd55a6a3
MD5 94d840a59581a9a90e9ed89ec2188e28
BLAKE2b-256 751984c3c8759149b268f9428bad282cd8bccbeb049284810a67180597c5520e

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