Python documentation generator

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for AA-Turner from gravatar.com AA-Turner Avatar for tk0miya from gravatar.com tk0miya

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

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

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for AA-Turner from gravatar.com AA-Turner Avatar for tk0miya from gravatar.com tk0miya

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

This version

9.0.4

9.0.3

9.0.2

9.0.1

9.0.0

9.0.0rc4 pre-release

9.0.0rc3 pre-release

9.0.0rc2 pre-release

9.0.0rc1 pre-release

8.3.0 yanked

Reason this release was yanked:

Bad release

8.2.3

8.2.2

8.2.1

8.2.0

8.2.0rc2 pre-release

8.2.0rc1 pre-release

8.1.3

8.1.2

8.1.1

8.1.0

8.0.2

8.0.1

8.0.0

8.0.0rc1 pre-release

7.4.7

7.4.6

7.4.5

7.4.4

7.4.3

7.4.2

7.4.1

7.4.0

7.3.7

7.3.6

7.3.5

7.3.4

7.3.3

7.3.2

7.3.1

7.3.0

7.2.6

7.2.5

7.2.4

7.2.3

7.2.2

7.2.1

7.2.0

7.1.2

7.1.1

7.1.0

7.0.1

7.0.0

7.0.0rc1 pre-release

6.2.1

6.2.0

6.1.3

6.1.2

6.1.1

6.1.0

6.0.1

6.0.0

6.0.0b2 pre-release

6.0.0b1 pre-release

5.3.0

5.2.3

5.2.2

5.2.1

5.2.0.post0

5.2.0

5.1.1

5.1.0

5.0.2

5.0.1

5.0.0

5.0.0b1 pre-release

4.5.0

4.4.0

4.3.2

4.3.1

4.3.0

4.2.0

4.1.2

4.1.1

4.1.0

4.0.3

4.0.2

4.0.1

4.0.0

4.0.0b2 pre-release

4.0.0b1 pre-release

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.3

3.4.2

3.4.1

3.4.0

3.3.1

3.3.0

3.2.1

3.2.0

3.1.2

3.1.1

3.1.0

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

3.0.0b1 pre-release

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.1

2.3.0

2.2.2

2.2.1

2.2.0

2.1.2

2.1.1

2.1.0

2.0.1

2.0.0

2.0.0b2 pre-release

2.0.0b1 pre-release

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.8.0b1 pre-release

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.7.0b2 pre-release

1.7.0b1 pre-release

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6b3 pre-release

1.6b2 pre-release

1.6b1 pre-release

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5

1.5b1 pre-release

1.5a2 pre-release

1.5a1 pre-release

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4

1.4b1 pre-release

1.4a1 pre-release

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3

1.3b3 pre-release

1.3b2 pre-release

1.3b1 pre-release

1.2.3

1.2.2

1.2.1

1.2

1.2b3 pre-release

1.2b2 pre-release

1.2b1 pre-release

1.1.3

1.1.2

1.1.1

1.1

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

1.0b2 pre-release

1.0b1 pre-release

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6

0.6b1 pre-release

0.5.2

0.5.2b1 pre-release

0.5.1

0.5

0.4.3

0.4.2

0.4.1

0.4

0.3

0.2

0.1.61950

0.1.61945

0.1.61843

0.1.61798

0.1.61611

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.4.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.4-py3-none-any.whl (3.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-9.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 594ef59d042972abbc581d8baa577404abe4e6c3b04ef61bd7fc2acbd51f3fa3
MD5 94006d876ec8d62ed757675921636c26
BLAKE2b-256 4250a8c6ccc36d5eacdfd7913ddccd15a9cee03ecafc5ee2bc40e1f168d85022

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: sphinx-9.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5bebc595a5e943ea248b99c13814c1c5e10b3ece718976824ffa7959ff95fffb
MD5 0cbe954a23ae5c1085b0302f6ae979db
BLAKE2b-256 c63f4bbd76424c393caead2e1eb89777f575dee5c8653e2d4b6afd7a564f5974

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx-9.0.4-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 Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page