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

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

This version

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

Uploaded Source

Built Distributions

Sphinx-1.0.7-py2.7.egg (1.1 MB view details)

Uploaded Source

Sphinx-1.0.7-py2.6.egg (1.1 MB view details)

Uploaded Source

Sphinx-1.0.7-py2.5.egg (1.1 MB view details)

Uploaded Source

Sphinx-1.0.7-py2.4.egg (1.1 MB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.0.7.tar.gz
Algorithm Hash digest
SHA256 80d62f3f7913c3322bf279ec26bfb12c1ce70404b00f4c87dc3ac190d150b0ab
MD5 42c722d48e52d4888193965dd473adb5
BLAKE2b-256 a23c6c1897c66b09fd648df3286bca68b6ce6a067e1e0315578bce143c80696e

See more details on using hashes here.

File details

Details for the file Sphinx-1.0.7-py2.7.egg.

File metadata

  • Download URL: Sphinx-1.0.7-py2.7.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.0.7-py2.7.egg
Algorithm Hash digest
SHA256 ab5c289aa6951d74fc027deae527276e169caa4dd8ecc2cb411a7b19048a02d6
MD5 1321a3888d4fad656a5ede5838686e12
BLAKE2b-256 5331c4880d13a270ba2b8b7cc7743f7d34d00133685e951c28217ff2b704559a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-1.0.7-py2.6.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.0.7-py2.6.egg
Algorithm Hash digest
SHA256 002bb220f8557c7931f5172323496f0a711cde8fd0d388a59ed6610ab9a2d055
MD5 a547658740040dd87ef71fbf723e7962
BLAKE2b-256 c00b9815ff6a417fc20c69e1f3cb1cb1b4bdba3fc84628438e2fc8067a3c6100

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-1.0.7-py2.5.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.0.7-py2.5.egg
Algorithm Hash digest
SHA256 d50eed2863ebd0c21bbe42845cbb7a38f7afd96ad3d1418df724e294c1c988df
MD5 f1607f94e0431bad74fabd18366fdbbf
BLAKE2b-256 16d895fc7ae6138172e3b8998a0b98bfd5536dfc823b8aea8f5ee1ff27358280

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Sphinx-1.0.7-py2.4.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sphinx-1.0.7-py2.4.egg
Algorithm Hash digest
SHA256 239af845e59b637e074bb27568305f82344d5ff366b415ef1ab540c63d727518
MD5 f77624e49a3a2bf45d7262722cf51bbb
BLAKE2b-256 829086d3dfe5910924ec1816c024699c3f01914e9626ee4d5916cbd7075d6e38

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