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.3b1.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

Sphinx-1.3b1-py2.py3-none-any.whl (1.3 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file Sphinx-1.3b1.tar.gz.

File metadata

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

File hashes

Hashes for Sphinx-1.3b1.tar.gz
Algorithm Hash digest
SHA256 a209c682e6770e29903883c9f0a684830245aa7eb9dec54b596cce644e9a364d
MD5 c9be45edbec48f4e4e7cfc53831c2225
BLAKE2b-256 c0b6ab5436ec909ea95c307c5347fd8b00c1292de9d6b4f147adf0b0017c0259

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.3b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3a1e57a446184a433e2bc7b7aa0dfb9fe835f3bb9c3d07e24b52b25cd5f30916
MD5 81f87b64b91d3a92c4b18f44d130fc2e
BLAKE2b-256 6e833b4f374a8eedfdcd65698639bcaf340afee0432607f32511a5d02170ebdd

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