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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file Sphinx-1.4a1.tar.gz.

File metadata

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

File hashes

Hashes for Sphinx-1.4a1.tar.gz
Algorithm Hash digest
SHA256 bb69d1c5f1e772f2dacea7fd8638defd6fb9c561cf1fecd58dbc5083883009b4
MD5 fb8e80e2883a2862b7ea012544444897
BLAKE2b-256 0d5ea2a74f02519f1fa9b63f82615b50c66fbc0cf031933f8f16745845310a45

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.4a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6f1a8767ce97521587554be63b4808a550cf4236f2932f0271b8fe1a0e345373
MD5 adfd9027da82fccc937eca6ce6eb87fc
BLAKE2b-256 56c0bf4e77ef5f26600f76c903a203dd8f2b1dd9b3f68347a9ea76296d16d8d2

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