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 to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects.

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.

Although it is still under constant development, the following features are already present, work fine and can be seen “in action” in the Python docs:

  • Output formats: HTML (including Windows HTML Help), plain text and LaTeX, for printable PDF versions

  • 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

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

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

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

This version

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-0.6b1.tar.gz (1.0 MB view details)

Uploaded Source

Built Distributions

Sphinx-0.6b1-py2.6.egg (637.5 kB view details)

Uploaded Source

Sphinx-0.6b1-py2.5.egg (638.0 kB view details)

Uploaded Source

Sphinx-0.6b1-py2.4.egg (645.0 kB view details)

Uploaded Source

File details

Details for the file Sphinx-0.6b1.tar.gz.

File metadata

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

File hashes

Hashes for Sphinx-0.6b1.tar.gz
Algorithm Hash digest
SHA256 82713e0e2ab6d3d7d251e5ec296f5a3106352981d9d8b1a781f9e4a708a757f9
MD5 c2518f36c78edf87009897a9778ec36a
BLAKE2b-256 557c40db42669c2e45146939a4a27584e77c7bd17558cb4f919570d4124348c1

See more details on using hashes here.

File details

Details for the file Sphinx-0.6b1-py2.6.egg.

File metadata

  • Download URL: Sphinx-0.6b1-py2.6.egg
  • Upload date:
  • Size: 637.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.6b1-py2.6.egg
Algorithm Hash digest
SHA256 e8957b23591557bb56eec4a2a33504cb825be366475c5ef5cf78ba1ced133d5e
MD5 b7cc5643888d75152979e8a35630a3ff
BLAKE2b-256 71c0a708a1804a4d17b26863152d6d8c78f6e877aba3314eaf464ceb7014c603

See more details on using hashes here.

File details

Details for the file Sphinx-0.6b1-py2.5.egg.

File metadata

  • Download URL: Sphinx-0.6b1-py2.5.egg
  • Upload date:
  • Size: 638.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.6b1-py2.5.egg
Algorithm Hash digest
SHA256 dcba98d7a30cf32f3c5dca621929915bea6bcaf329236c4bcd087a780c4a51e2
MD5 b877f156e5c4b22257c47873021da3d2
BLAKE2b-256 e7a4013c0da029ee9dddc79da8af250b56e62dbe7e4c86d6cd3e52fb827914de

See more details on using hashes here.

File details

Details for the file Sphinx-0.6b1-py2.4.egg.

File metadata

  • Download URL: Sphinx-0.6b1-py2.4.egg
  • Upload date:
  • Size: 645.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.6b1-py2.4.egg
Algorithm Hash digest
SHA256 fa05b56c27fc674de48c39f2e0a12644196a44748050cb7d2d3b0d39c469c7d6
MD5 da658fcefcbcbbf28c1933e6ed2e08f5
BLAKE2b-256 6e3765fc63a6c06d93fffc05ba2ab2e77eeabf1b603ba9255c655ba80928c8a9

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