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.

A development egg can be found here.

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

This version

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-0.6.7.tar.gz (974.6 kB view details)

Uploaded Source

Built Distributions

Sphinx-0.6.7-py2.6.egg (661.4 kB view details)

Uploaded Source

Sphinx-0.6.7-py2.5.egg (661.9 kB view details)

Uploaded Source

Sphinx-0.6.7-py2.4.egg (669.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: Sphinx-0.6.7.tar.gz
  • Upload date:
  • Size: 974.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-0.6.7.tar.gz
Algorithm Hash digest
SHA256 3127fe8be43d8150d02f0ae81d3ea82815325c161653d39d08f5d283f4588577
MD5 54c3e4045ee4a4997a50c225f36e92fd
BLAKE2b-256 e23b3766991dc30b590fd1246b291fc846b29b71b677d359da0845810816c48c

See more details on using hashes here.

File details

Details for the file Sphinx-0.6.7-py2.6.egg.

File metadata

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

File hashes

Hashes for Sphinx-0.6.7-py2.6.egg
Algorithm Hash digest
SHA256 2d516a02b3679b8ed89327f391f9c3b1fcb19fc104b83d8d9a43336cd0ddb8b4
MD5 a002502c36bc43fa58d14a7c4cb092c4
BLAKE2b-256 4ff5ebe470be46c320bb55ef3c85da4776f3f9c3164299923a2acc097e16bf09

See more details on using hashes here.

File details

Details for the file Sphinx-0.6.7-py2.5.egg.

File metadata

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

File hashes

Hashes for Sphinx-0.6.7-py2.5.egg
Algorithm Hash digest
SHA256 a6a8e8ecc807492e57b334d9225b05a697bc426d90fad7dde2485cb03bec5e8e
MD5 bc4bc8b2d2299d0221fc1ec0ab62c891
BLAKE2b-256 77d8025a0cc47605e691bdc1f9bf4135e73f98d8f21e455345a091b46de7837c

See more details on using hashes here.

File details

Details for the file Sphinx-0.6.7-py2.4.egg.

File metadata

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

File hashes

Hashes for Sphinx-0.6.7-py2.4.egg
Algorithm Hash digest
SHA256 95a71d807b279a1f5e46d33bb7dd93cea4130e8b66efd62b2de8be6aaf2e78c0
MD5 1a1de68fa04879c6df051bd0376af32d
BLAKE2b-256 cdebc1f3e29c3ae51785272273594330ed917c6ac0e4f36b556f15a0d2f56ef5

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