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.

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.7.3.tar.gz
Algorithm Hash digest
SHA256 9495a1f78c13d0a725ab8104e923e9663519ecc04552aa4a8f684c2da355443d
MD5 d363e6cd778061e542e3fad97e2fc307
BLAKE2b-256 ffbda709626705bb1f13b86904f6caaf53e3d088cbf2919b678296ce11fd646c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Sphinx-1.7.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3aded1a355f662547b8a948131f3faecbc3dea8951847fe0ee4c59689f8220b2
MD5 a4d4c490c2afac54004374286881462a
BLAKE2b-256 240f09869a479c626e860451a8b2cc7ed516abd93681b414e3aa9cddbe75f44b

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