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

Uploaded Source

Built Distribution

Sphinx-1.6.3-py2.py3-none-any.whl (1.9 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.6.3.tar.gz
Algorithm Hash digest
SHA256 af8bdb8c714552b77d01d4536e3d6d2879d6cb9d25423d29163d5788e27046e6
MD5 c5ad61f4e0974375ca2c2b58ef8d5411
BLAKE2b-256 1091ceb2e0d763e0c626f7afd7e3272a5bb76dd06eed1f0b908270ea31984062

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.6.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3ea0faf3e152a0e40372d8495c8cbd59e93f89266231c367d8098ec0dfede98f
MD5 8086a197fea0a70637fdec50c616f534
BLAKE2b-256 2d9697bebe9e13284fac32b6712ddf1dab5441f649ef24343ebfec98ba017553

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page