Skip to main content

Python documentation generator

Project description

Package on PyPI Build Status Documentation Status BSD 2 Clause

Sphinx makes it easy to create intelligent and beautiful documentation.

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.

Features

  • Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more

  • 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 highlighting: automatic highlighting using the Pygments highlighter

  • Templating: Flexible HTML output using the Jinja 2 templating engine

  • Extension ecosystem: Many extensions are available, for example for automatic function documentation or working with Jupyter notebooks.

  • Language Support: Python, C, C++, JavaScript, mathematics, and many other languages through extensions.

For more information, refer to the the documentation.

Installation

The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

pip install -U sphinx

Contributing

We appreciate all contributions! Refer to the contributors guide for information.

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

Uploaded Source

Built Distribution

sphinx-5.2.2-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Sphinx-5.2.2.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for Sphinx-5.2.2.tar.gz
Algorithm Hash digest
SHA256 7225c104dc06169eb73b061582c4bc84a9594042acae6c1582564de274b7df2f
MD5 238591332d1bc94b491551dc84f26aa7
BLAKE2b-256 7e7978be8beb3a0d39431e2c29d837f85fe3df77d31c92216ce22d7961607ef3

See more details on using hashes here.

File details

Details for the file sphinx-5.2.2-py3-none-any.whl.

File metadata

  • Download URL: sphinx-5.2.2-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sphinx-5.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9150a8ed2e98d70e778624373f183c5498bf429dd605cf7b63e80e2a166c35a5
MD5 c14dbc4704defef90249095eff863da9
BLAKE2b-256 f0e5aa7a7622cb708c0525c473a52ade07e078a9241092c32705e941d4d6878e

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