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

1.0.7

1.0.6

This version

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

Uploaded Source

Built Distributions

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

Uploaded Source

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

Uploaded Source

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.0.5.tar.gz
Algorithm Hash digest
SHA256 97d7613b915d69e0f68ee2e3ff5618bd16ac1177e0bf8264ece6ffe7d183fb1d
MD5 9c2cbfb4f520c49cedd10d0b26196832
BLAKE2b-256 54cb5d8fde52ee694bc61115f25421b95d4a47fd07723d30f315fc65b3b4046c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.0.5-py2.6.egg
Algorithm Hash digest
SHA256 534193a1f8a8d87a2483131404405eab74c9be65b2556bf8030e19a9907edfe0
MD5 b40aced6f1d0f9394e08337e578b0ae3
BLAKE2b-256 217967f4cacf1c1feaf134861e0cb61958a7f6cbe258113b1551c136ef5cebd1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.0.5-py2.5.egg
Algorithm Hash digest
SHA256 c591bcd08684d878a13e113a03030836435493f6e4423da385732dd5b96825bb
MD5 cc0008f8b7db3f40c759b25d38dabf02
BLAKE2b-256 197a8683702eb70694d59f93aeb207f531ad045f97b20171d820aedaacc6dcd1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.0.5-py2.4.egg
Algorithm Hash digest
SHA256 73e72eb36bd8ffc6d037ab71cf6d55984a8a27c3ef37eb240d5deec06fe03908
MD5 3d5583eaa051928e775907b6d62d5507
BLAKE2b-256 806b54f670b6eed6a486ef2d89081a9c8067b033dcc9685ddda1f0d11389b33e

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