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

Uploaded Source

Built Distribution

Sphinx-1.8.2-py2.py3-none-any.whl (3.1 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: Sphinx-1.8.2.tar.gz
  • Upload date:
  • Size: 5.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for Sphinx-1.8.2.tar.gz
Algorithm Hash digest
SHA256 120732cbddb1b2364471c3d9f8bfd4b0c5b550862f99a65736c77f970b142aea
MD5 7d1eca311bf3967a5daa9e697293af30
BLAKE2b-256 4cea7388faba7cf02999e1bc42f6a8eb1ea0120aec3dd93474cee21cea2d693f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-1.8.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for Sphinx-1.8.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b348790776490894e0424101af9c8413f2a86831524bd55c5f379d3e3e12ca64
MD5 c117ddfcb5d564f4b3e41f82732ab4e0
BLAKE2b-256 ffd53a8727d6f890b1ae45da72a55bf8449e9f2c535a444923b338c3f509f203

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