Python documentation generator

Navigation

Verified details

These details have been verified by PyPI
Owner
organization icon Sphinx
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

Project description

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned.

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.

Among its features are the following:

  • Output formats: HTML (including derivative formats such as HTML Help, Epub and Qt Help), plain text, manual pages and LaTeX or direct PDF output using rst2pdf

  • 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 handling: automatic highlighting using the Pygments highlighter

  • Flexible HTML output using the Jinja 2 templating engine

  • Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings

  • Setuptools integration

Project details

Verified details

These details have been verified by PyPI
Owner
organization icon Sphinx
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

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

This version

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-1.2.2.tar.gz (3.1 MB view details)

Uploaded Source

Built Distributions

Sphinx-1.2.2-py33-none-any.whl (1.1 MB view details)

Uploaded Python 3.3

Sphinx-1.2.2-py32-none-any.whl (1.1 MB view details)

Uploaded Python 3.2

Sphinx-1.2.2-py27-none-any.whl (1.1 MB view details)

Uploaded Python 2.7

Sphinx-1.2.2-py26-none-any.whl (1.1 MB view details)

Uploaded Python 2.6

File details

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

File metadata

  • Download URL: Sphinx-1.2.2.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.2.2.tar.gz
Algorithm Hash digest
SHA256 2d3415f5b3e6b7535877f4c84fe228bdb802a8993c239b2d02c23169d67349bd
MD5 3dc73ccaa8d0bfb2d62fb671b1f7e8a4
BLAKE2b-256 0a5034017e6efcd372893a416aba14b84a1a149fc7074537b0e9cb6ca7b7abe9

See more details on using hashes here.

File details

Details for the file Sphinx-1.2.2-py33-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.2.2-py33-none-any.whl
Algorithm Hash digest
SHA256 fc0e5b990027de6af007cdb6685017f15c92463870852c9243a9fc2b225f025e
MD5 11b32b21df7b92369b68207397070266
BLAKE2b-256 a92a7f3ecd9be313a164e35d80c103bd7cd23dbcf81200ec7a083c0226b67814

See more details on using hashes here.

File details

Details for the file Sphinx-1.2.2-py32-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.2.2-py32-none-any.whl
Algorithm Hash digest
SHA256 45bc3f1b28746e379a2edddc43f1b97b084f5a29093beb7bc228c2a9ab3966d3
MD5 fa32ae0619a109a989e7bdaa2a5ac805
BLAKE2b-256 59a1c74b4ec5edc55b00a69d4a56bb4fe99ea08db790809ec869d8a8c1162d33

See more details on using hashes here.

File details

Details for the file Sphinx-1.2.2-py27-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.2.2-py27-none-any.whl
Algorithm Hash digest
SHA256 9545ffe4fd17b19f8b81569a65076ec1a1972018dccc6d70b9f236265030c75f
MD5 aa3dccfcf8dd6394b25c61fc1a15fba8
BLAKE2b-256 ff91edcbcd8126333cf69493fc2a0f1663ffef26d267024125ffd7bd50137bdb

See more details on using hashes here.

File details

Details for the file Sphinx-1.2.2-py26-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.2.2-py26-none-any.whl
Algorithm Hash digest
SHA256 c4ca22128b83a96ddd76b757c9d14c4b4b35c5d617d91094bc983b207b5fb25d
MD5 4d26aa9fb5881c70794a2ecad2553ef3
BLAKE2b-256 0ed14f0b40504fdce1535ce48374c3c077edb2518fb9a38b2657f59360bb8afc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page