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:

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

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-6.1.0.tar.gz (6.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-6.1.0-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-6.1.0.tar.gz
Algorithm Hash digest
SHA256 b0fd0a1993733492572bbd429b5ec081e17c082b5b5168ffae50524c3a90fd3c
MD5 9dc819396bd732e0e6d5855ed69808ad
BLAKE2b-256 f617ec54f1d8980bd8ec2bd4ca0e77ba6086d3db5aee718304593ba83f864125

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx-6.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for sphinx-6.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7569d01418166c079560751038ab1c0ddca3b15c74787cc60b16d7f11a4bf35a
MD5 0b40854b91ba3f558c24acdea48e973a
BLAKE2b-256 5edd1bb2e6dbdcb4ab4eba960a0073c164a0239e3b2cab191ca25a9eefa7e9e7

See more details on using hashes here.

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

9.0.1

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

This release

6.1.0 This release

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