Skip to main content

Sphinx

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.

Release files for Sphinx 7.4.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Sphinx 7.4.5
File Size Uploaded Provenance Actions
sphinx-7.4.5.tar.gz 8.1 MB Without provenance Details for sphinx-7.4.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for Sphinx 7.4.5
File Interpreter ABI Platform Actions
sphinx-7.4.5-py3-none-any.whl Python 3 none any Details for sphinx-7.4.5-py3-none-any.whl

Total release size: 11.6 MB

Release files / sphinx-7.4.5.tar.gz

Download URL sphinx-7.4.5.tar.gz
Size 8.1 MB
Tags Source
SHA-256 checksum
How to use checksums
a4abe5385bf856df094c1e6cadf24a2351b12057be3670b99a12c05a01d209f5
BLAKE2b-256 checksum
How to use checksums
358999d9fab99f04a94dc0344494c0f574b6e730994c4f3ce023b03575363472
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / sphinx-7.4.5-py3-none-any.whl

Download URL sphinx-7.4.5-py3-none-any.whl
Size 3.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9f135d8c1d277db67be514be579c4c4a26c8c0e962219aaca5a721b04bd6d0d8
BLAKE2b-256 checksum
How to use checksums
03686024fd028a1f7cd9e29464710ba49e33e747a40501ad51942d6718cd6353
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.4

Security for Sphinx 7.4.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.4.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page