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 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.

Project details


Release history Release notifications | RSS feed

This version

8.2.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-8.2.3.tar.gz (8.3 MB view details)

Uploaded Source

Built Distribution

sphinx-8.2.3-py3-none-any.whl (3.6 MB view details)

Uploaded Python 3

File details

Details for the file sphinx-8.2.3.tar.gz.

File metadata

  • Download URL: sphinx-8.2.3.tar.gz
  • Upload date:
  • Size: 8.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for sphinx-8.2.3.tar.gz
Algorithm Hash digest
SHA256 398ad29dee7f63a75888314e9424d40f52ce5a6a87ae88e7071e80af296ec348
MD5 eec3083f144d88cf65ad3da422fc7e66
BLAKE2b-256 38ad4360e50ed56cb483667b8e6dadf2d3fda62359593faabbe749a27c4eaca6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx-8.2.3.tar.gz:

Publisher: create-release.yml on sphinx-doc/sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: sphinx-8.2.3-py3-none-any.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for sphinx-8.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4405915165f13521d875a8c29c8970800a0141c14cc5416a38feca4ea5d9b9c3
MD5 9a95032cbd2859f426385091aa7ecb24
BLAKE2b-256 3153136e9eca6e0b9dc0e1962e2c908fbea2e5ac000c2a2fbd9a35797958c48b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx-8.2.3-py3-none-any.whl:

Publisher: create-release.yml on sphinx-doc/sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page