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

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: Georg Brandl

License

BSD License

Requires

Python >=3.9

Classifiers

Report project as malware

Release files for Sphinx 7.3.4

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.3.4
File Size Uploaded
sphinx-7.3.4.tar.gz 7.1 MB Details

Built distribution (wheel)

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

Total release size: 10.4 MB

Release files / sphinx-7.3.4.tar.gz

Download URL sphinx-7.3.4.tar.gz
Size 7.1 MB
Tags Source
SHA-256 checksum
How to use checksums 		614826a7cf76f0a4525875c3ed55e2c3618f906897cb7ad53511c5fedcbb35aa
BLAKE2b-256 checksum
How to use checksums 		0e3b5cdf0dbaa8fa39ce39b4f9611cd64c2c70d127a4bca236e3b44feeba8f64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/5.0.0 CPython/3.12.2

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

Download URL sphinx-7.3.4-py3-none-any.whl
Size 3.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums 		f67400c457599a6cfd967b681e093b43892b8df71596774b3128e31b6f0899eb
BLAKE2b-256 checksum
How to use checksums 		cab9dad10445fc63228d63c3744630a2a7b1002c495d27d4df2f02dbeb830628
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

9.1.0

2 release files

Pre-release

9.1.0rc2

2 release files

Pre-release

9.1.0rc1

2 release files

9.0.4

2 release files

9.0.3

2 release files

9.0.2

2 release files

9.0.1

2 release files

9.0.0

2 release files

Pre-release

9.0.0rc4

2 release files

Pre-release

9.0.0rc3

2 release files

Pre-release

9.0.0rc2

2 release files

Pre-release

9.0.0rc1

2 release files

Yanked

8.3.0

2 release files

Yanked reason: Bad release

8.2.3

2 release files

8.2.2

2 release files

8.2.1

2 release files

8.2.0

2 release files

Pre-release

8.2.0rc2

2 release files

Pre-release

8.2.0rc1

2 release files

8.1.3

2 release files

8.1.2

2 release files

8.1.1

2 release files

8.1.0

2 release files

8.0.2

2 release files

8.0.1

2 release files

8.0.0

2 release files

Pre-release

8.0.0rc1

2 release files

7.4.7

2 release files

7.4.6

2 release files

7.4.5

2 release files

7.4.4

2 release files

7.4.3

2 release files

7.4.2

2 release files

7.4.1

2 release files

7.4.0

2 release files

7.3.7

2 release files

7.3.6

2 release files

7.3.5

2 release files

This release

7.3.4 This release

2 release files

7.3.3

2 release files

7.3.2

2 release files

7.3.1

2 release files

7.3.0

2 release files

7.2.6

2 release files

7.2.5

2 release files

7.2.4

2 release files

7.2.3

2 release files

7.2.2

2 release files

7.2.1

2 release files

7.2.0

2 release files

7.1.2

2 release files

7.1.1

2 release files

7.1.0

2 release files

7.0.1

2 release files

7.0.0

2 release files

Pre-release

7.0.0rc1

2 release files

6.2.1

2 release files

6.2.0

2 release files

6.1.3

2 release files

6.1.2

2 release files

6.1.1

2 release files

6.1.0

2 release files

6.0.1

2 release files

6.0.0

2 release files

Pre-release

6.0.0b2

2 release files

Pre-release

6.0.0b1

2 release files

5.3.0

2 release files

5.2.3

2 release files

5.2.2

2 release files

5.2.1

2 release files

5.2.0.post0

2 release files

5.2.0

2 release files

5.1.1

2 release files

5.1.0

2 release files

5.0.2

2 release files

5.0.1

2 release files

5.0.0

2 release files

Pre-release

5.0.0b1

2 release files

4.5.0

2 release files

4.4.0

2 release files

4.3.2

2 release files

4.3.1

2 release files

4.3.0

2 release files

4.2.0

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

2 release files

Pre-release

4.0.0b2

2 release files

Pre-release

4.0.0b1

2 release files

3.5.4

2 release files

3.5.3

2 release files

3.5.2

2 release files

3.5.1

2 release files

3.5.0

2 release files

3.4.3

2 release files

3.4.2

2 release files

3.4.1

2 release files

3.4.0

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.1

2 release files

3.2.0

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

Pre-release

3.0.0b1

2 release files

2.4.5

2 release files

2.4.4

2 release files

2.4.3

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

Pre-release

2.0.0b2

2 release files

Pre-release

2.0.0b1

2 release files

1.8.6

2 release files

1.8.5

2 release files

1.8.4

2 release files

1.8.3

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.8.0

2 release files

Pre-release

1.8.0b1

2 release files

1.7.9

2 release files

1.7.8

2 release files

1.7.7

2 release files

1.7.6

2 release files

1.7.5

2 release files

1.7.4

2 release files

1.7.3

2 release files

1.7.2

2 release files

1.7.1

2 release files

1.7.0

2 release files

Pre-release

1.7.0b2

2 release files

Pre-release

1.7.0b1

2 release files

1.6.7

2 release files

1.6.6

2 release files

1.6.5

2 release files

1.6.4

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

Pre-release

1.6b3

2 release files

Pre-release

1.6b2

2 release files

Pre-release

1.6b1

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5

2 release files

Pre-release

1.5b1

2 release files

Pre-release

1.5a2

2 release files

Pre-release

1.5a1

2 release files

1.4.9

2 release files

1.4.8

2 release files

1.4.7

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4

2 release files

Pre-release

1.4b1

2 release files

Pre-release

1.4a1

2 release files

1.3.6

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3

2 release files

Pre-release

1.3b3

2 release files

Pre-release

1.3b2

2 release files

Pre-release

1.3b1

2 release files

1.2.3

3 release files

1.2.2

5 release files

1.2.1

5 release files

1.2

6 release files

Pre-release

1.2b3

2 release files

Pre-release

1.2b2

2 release files

Pre-release

1.2b1

2 release files

1.1.3

3 release files

1.1.2

3 release files

1.1.1

2 release files

1.1

3 release files

1.0.8

3 release files

1.0.7

5 release files

1.0.6

5 release files

1.0.5

4 release files

1.0.4

4 release files

1.0.3

4 release files

1.0.2

4 release files

1.0.1

4 release files

1.0

4 release files

Pre-release

1.0b2

4 release files

Pre-release

1.0b1

4 release files

0.6.7

4 release files

0.6.6

4 release files

0.6.5

4 release files

0.6.4

4 release files

0.6.3

4 release files

0.6.2

4 release files

0.6.1

4 release files

0.6

4 release files

Pre-release

0.6b1

4 release files

0.5.2

4 release files

Pre-release

0.5.2b1

4 release files

0.5.1

4 release files

0.5

4 release files

0.4.3

3 release files

0.4.2

3 release files

0.4.1

3 release files

0.4

3 release files

0.3

3 release files

0.2

3 release files

0.1.61950

3 release files

0.1.61945

3 release files

0.1.61843

3 release files

0.1.61798

3 release files

0.1.61611

3 release 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