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 links

Data verified by PyPI on Dec 1, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (9.1.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for AA-Turner from gravatar.com AA-Turner Avatar for tk0miya from gravatar.com tk0miya

Credits

Author: Adam Turner

GitHub Statistics

Data verified by PyPI on Dec 1, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-2-Clause
View SPDX License List

Requires

Python >=3.11

Classifiers

Report project as malware

Download files

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

Source Distribution

sphinx-9.0.1.tar.gz (8.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx-9.0.1-py3-none-any.whl (3.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-9.0.1.tar.gz
  • Upload date:
  • Size: 8.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for sphinx-9.0.1.tar.gz
Algorithm Hash digest
SHA256 c820d856657ce7cd41ce2c097f478ac3d7ddad9779ad83de4f0136a81ff388fd
MD5 9ea2be0953cb31c8bb04e6945be92c3e
BLAKE2b-256 bbf57aedfbc7833b7e40c9c921c4f813e22c0abc1d8ee5f778c479c102001d7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx-9.0.1.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-9.0.1-py3-none-any.whl.

File metadata

  • Download URL: sphinx-9.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for sphinx-9.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a9506b709d6bd3d4c3f142b5b58801c202837b54875727e3adcba98d4839735
MD5 b03b221f74440a44e5d024f6caa80ef0
BLAKE2b-256 f3121b79cd17cca23962a4a973b04afbe7008d6bec51a9b39db1b563e63f427e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx-9.0.1-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.

Release history Release notifications | RSS feed

9.1.0

2 files

Pre-release

9.1.0rc2

2 files

Pre-release

9.1.0rc1

2 files

9.0.4

2 files

9.0.3

2 files

9.0.2

2 files

This release

9.0.1 This release

2 files

9.0.0

2 files

Pre-release

9.0.0rc4

2 files

Pre-release

9.0.0rc3

2 files

Pre-release

9.0.0rc2

2 files

Pre-release

9.0.0rc1

2 files

Yanked

8.3.0

2 files

Yanked reason: Bad release

8.2.3

2 files

8.2.2

2 files

8.2.1

2 files

8.2.0

2 files

Pre-release

8.2.0rc2

2 files

Pre-release

8.2.0rc1

2 files

8.1.3

2 files

8.1.2

2 files

8.1.1

2 files

8.1.0

2 files

8.0.2

2 files

8.0.1

2 files

8.0.0

2 files

Pre-release

8.0.0rc1

2 files

7.4.7

2 files

7.4.6

2 files

7.4.5

2 files

7.4.4

2 files

7.4.3

2 files

7.4.2

2 files

7.4.1

2 files

7.4.0

2 files

7.3.7

2 files

7.3.6

2 files

7.3.5

2 files

7.3.4

2 files

7.3.3

2 files

7.3.2

2 files

7.3.1

2 files

7.3.0

2 files

7.2.6

2 files

7.2.5

2 files

7.2.4

2 files

7.2.3

2 files

7.2.2

2 files

7.2.1

2 files

7.2.0

2 files

7.1.2

2 files

7.1.1

2 files

7.1.0

2 files

7.0.1

2 files

7.0.0

2 files

Pre-release

7.0.0rc1

2 files

6.2.1

2 files

6.2.0

2 files

6.1.3

2 files

6.1.2

2 files

6.1.1

2 files

6.1.0

2 files

6.0.1

2 files

6.0.0

2 files

Pre-release

6.0.0b2

2 files

Pre-release

6.0.0b1

2 files

5.3.0

2 files

5.2.3

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0.post0

2 files

5.2.0

2 files

5.1.1

2 files

5.1.0

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

Pre-release

5.0.0b1

2 files

4.5.0

2 files

4.4.0

2 files

4.3.2

2 files

4.3.1

2 files

4.3.0

2 files

4.2.0

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

Pre-release

4.0.0b2

2 files

Pre-release

4.0.0b1

2 files

3.5.4

2 files

3.5.3

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.3

2 files

3.4.2

2 files

3.4.1

2 files

3.4.0

2 files

3.3.1

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.4

2 files

3.0.3

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

Pre-release

3.0.0b1

2 files

2.4.5

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.1

2 files

2.3.0

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

Pre-release

2.0.0b2

2 files

Pre-release

2.0.0b1

2 files

1.8.6

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

Pre-release

1.8.0b1

2 files

1.7.9

2 files

1.7.8

2 files

1.7.7

2 files

1.7.6

2 files

1.7.5

2 files

1.7.4

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

Pre-release

1.7.0b2

2 files

Pre-release

1.7.0b1

2 files

1.6.7

2 files

1.6.6

2 files

1.6.5

2 files

1.6.4

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

Pre-release

1.6b3

2 files

Pre-release

1.6b2

2 files

Pre-release

1.6b1

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5

2 files

Pre-release

1.5b1

2 files

Pre-release

1.5a2

2 files

Pre-release

1.5a1

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4

2 files

Pre-release

1.4b1

2 files

Pre-release

1.4a1

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3

2 files

Pre-release

1.3b3

2 files

Pre-release

1.3b2

2 files

Pre-release

1.3b1

2 files

1.2.3

3 files

1.2.2

5 files

1.2.1

5 files

1.2

6 files

Pre-release

1.2b3

2 files

Pre-release

1.2b2

2 files

Pre-release

1.2b1

2 files

1.1.3

3 files

1.1.2

3 files

1.1.1

2 files

1.1

3 files

1.0.8

3 files

1.0.7

5 files

1.0.6

5 files

1.0.5

4 files

1.0.4

4 files

1.0.3

4 files

1.0.2

4 files

1.0.1

4 files

1.0

4 files

Pre-release

1.0b2

4 files

Pre-release

1.0b1

4 files

0.6.7

4 files

0.6.6

4 files

0.6.5

4 files

0.6.4

4 files

0.6.3

4 files

0.6.2

4 files

0.6.1

4 files

0.6

4 files

Pre-release

0.6b1

4 files

0.5.2

4 files

Pre-release

0.5.2b1

4 files

0.5.1

4 files

0.5

4 files

0.4.3

3 files

0.4.2

3 files

0.4.1

3 files

0.4

3 files

0.3

3 files

0.2

3 files

0.1.61950

3 files

0.1.61945

3 files

0.1.61843

3 files

0.1.61798

3 files

0.1.61611

3 files

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