Skip to main content

Python documentation generator

Project description

Package on PyPI Documentation Status Build Status (AppVeyor) Build Status (CircleCI) Code Coverage Status (Codecov) BSD 3 Clause Open Source Helpers badge

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.

Please adhere to our code of conduct.

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

Uploaded Source

Built Distribution

Sphinx-4.1.1-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Sphinx-4.1.1.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for Sphinx-4.1.1.tar.gz
Algorithm Hash digest
SHA256 23c846a1841af998cb736218539bb86d16f5eb95f5760b1966abcd2d584e62b8
MD5 17ddb46bff77837aebd675d17a734593
BLAKE2b-256 a97bdd334e8d8178986b47760743b5fcee4a9796e10e1fc0ebe2bf6ac59c3a2e

See more details on using hashes here.

File details

Details for the file Sphinx-4.1.1-py3-none-any.whl.

File metadata

  • Download URL: Sphinx-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for Sphinx-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d513088236eef51e5b0adb78b0492eb22cc3b8ccdb0b36dd021173b365d4454
MD5 a94f8e99d3339ca7f7b14bda534d8c97
BLAKE2b-256 e0a10b983f8c23ca0eeb8573414ea9f0b6e0182b2a2e688a60c05b5a168158da

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