Skip to main content

Python documentation generator

Project description

Package on PyPI Documentation Status Build Status (Travis CI) Build Status (AppVeyor) Build Status (CircleCI) Code Coverage Status (Codecov)

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

For more information, refer to the the documentation.

Installation

Sphinx is published on PyPI and can be installed from there:

pip install -U sphinx

We also publish beta releases:

pip install -U --pre sphinx

If you wish to install Sphinx for development purposes, refer to the contributors guide.

Documentation

Documentation is available from sphinx-doc.org.

Get in touch

  • Report bugs, suggest features or view the source code on GitHub.

  • For less well defined questions or ideas, use the mailing list.

Testing

Continuous testing is provided by Travis (for unit tests and style checks on Linux), AppVeyor (for unit tests on Windows), and CircleCI (for large processes like TeX compilation).

For information on running tests locally, refer to the contributors guide.

Contributing

Refer to the contributors guide.

Release signatures

Releases are signed with following keys:

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

Uploaded Source

Built Distribution

Sphinx-2.1.1-py2.py3-none-any.whl (3.2 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: Sphinx-2.1.1.tar.gz
  • Upload date:
  • Size: 6.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for Sphinx-2.1.1.tar.gz
Algorithm Hash digest
SHA256 15143166e786c7faa76fa990d3b6b38ebffe081ef81cffd1d656b07f3b28a1fa
MD5 36728e607f5327916b94f4e76e3c3ceb
BLAKE2b-256 97492eb0837b5e8a7232c43e1ccf87caf49e2573ef370366511dfe9686cc97ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-2.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for Sphinx-2.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5fd62ba64235d77a81554d47ff6b17578171b6dbbc992221e9ebc684898fff59
MD5 a8b17195db75270c2872fcc6e4db2bb9
BLAKE2b-256 7cbc427495e0564ea7618458e113ecb1c90d48de604652b6eff24a66c9c312cc

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