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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (9.1.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for AA-Turner from gravatar.com AA-Turner Avatar for tk0miya from gravatar.com tk0miya

Credits

Author: Georg Brandl

License

BSD License (BSD)

Classifiers

Report project as malware

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Sphinx-1.5.6-py2.py3-none-any.whl (1.6 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for Sphinx-1.5.6.tar.gz
Algorithm Hash digest
SHA256 565a72dd39dd6ea2e8c548d34c127c981e4bcaead69a2c456a6e33ef69151ace
MD5 e5f3f34401f9658d6d28a8cce5191384
BLAKE2b-256 95d2811beb24fa68afeb673e7a069aa3dbb95f57b426075d734ed913b47ca2ec

See more details on using hashes here.

File details

Details for the file Sphinx-1.5.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Sphinx-1.5.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9d93711a0f71c2a21ee44e4fd844f9990b679c9eef951f60d22b19ad9e6e929d
MD5 834ade9b65497d360c40dc3f443b9403
BLAKE2b-256 cdc33fc2985e07f6111b47328be116df9e05d5c2f246a050e2e2ebf6bdc9c692

See more details on using hashes here.

Release history Release notifications | RSS feed

9.1.0

2 files

Pre-release

9.1.0rc2

2 files

Pre-release

9.1.0rc1

2 files

9.0.4

2 files

9.0.3

2 files

9.0.2

2 files

9.0.1

2 files

9.0.0

2 files

Pre-release

9.0.0rc4

2 files

Pre-release

9.0.0rc3

2 files

Pre-release

9.0.0rc2

2 files

Pre-release

9.0.0rc1

2 files

Yanked

8.3.0

2 files

Yanked reason: Bad release

8.2.3

2 files

8.2.2

2 files

8.2.1

2 files

8.2.0

2 files

Pre-release

8.2.0rc2

2 files

Pre-release

8.2.0rc1

2 files

8.1.3

2 files

8.1.2

2 files

8.1.1

2 files

8.1.0

2 files

8.0.2

2 files

8.0.1

2 files

8.0.0

2 files

Pre-release

8.0.0rc1

2 files

7.4.7

2 files

7.4.6

2 files

7.4.5

2 files

7.4.4

2 files

7.4.3

2 files

7.4.2

2 files

7.4.1

2 files

7.4.0

2 files

7.3.7

2 files

7.3.6

2 files

7.3.5

2 files

7.3.4

2 files

7.3.3

2 files

7.3.2

2 files

7.3.1

2 files

7.3.0

2 files

7.2.6

2 files

7.2.5

2 files

7.2.4

2 files

7.2.3

2 files

7.2.2

2 files

7.2.1

2 files

7.2.0

2 files

7.1.2

2 files

7.1.1

2 files

7.1.0

2 files

7.0.1

2 files

7.0.0

2 files

Pre-release

7.0.0rc1

2 files

6.2.1

2 files

6.2.0

2 files

6.1.3

2 files

6.1.2

2 files

6.1.1

2 files

6.1.0

2 files

6.0.1

2 files

6.0.0

2 files

Pre-release

6.0.0b2

2 files

Pre-release

6.0.0b1

2 files

5.3.0

2 files

5.2.3

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0.post0

2 files

5.2.0

2 files

5.1.1

2 files

5.1.0

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

Pre-release

5.0.0b1

2 files

4.5.0

2 files

4.4.0

2 files

4.3.2

2 files

4.3.1

2 files

4.3.0

2 files

4.2.0

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

Pre-release

4.0.0b2

2 files

Pre-release

4.0.0b1

2 files

3.5.4

2 files

3.5.3

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.3

2 files

3.4.2

2 files

3.4.1

2 files

3.4.0

2 files

3.3.1

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.4

2 files

3.0.3

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

Pre-release

3.0.0b1

2 files

2.4.5

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.1

2 files

2.3.0

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

Pre-release

2.0.0b2

2 files

Pre-release

2.0.0b1

2 files

1.8.6

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

Pre-release

1.8.0b1

2 files

1.7.9

2 files

1.7.8

2 files

1.7.7

2 files

1.7.6

2 files

1.7.5

2 files

1.7.4

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

Pre-release

1.7.0b2

2 files

Pre-release

1.7.0b1

2 files

1.6.7

2 files

1.6.6

2 files

1.6.5

2 files

1.6.4

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

Pre-release

1.6b3

2 files

Pre-release

1.6b2

2 files

Pre-release

1.6b1

2 files

This release

1.5.6 This release

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5

2 files

Pre-release

1.5b1

2 files

Pre-release

1.5a2

2 files

Pre-release

1.5a1

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4

2 files

Pre-release

1.4b1

2 files

Pre-release

1.4a1

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3

2 files

Pre-release

1.3b3

2 files

Pre-release

1.3b2

2 files

Pre-release

1.3b1

2 files

1.2.3

3 files

1.2.2

5 files

1.2.1

5 files

1.2

6 files

Pre-release

1.2b3

2 files

Pre-release

1.2b2

2 files

Pre-release

1.2b1

2 files

1.1.3

3 files

1.1.2

3 files

1.1.1

2 files

1.1

3 files

1.0.8

3 files

1.0.7

5 files

1.0.6

5 files

1.0.5

4 files

1.0.4

4 files

1.0.3

4 files

1.0.2

4 files

1.0.1

4 files

1.0

4 files

Pre-release

1.0b2

4 files

Pre-release

1.0b1

4 files

0.6.7

4 files

0.6.6

4 files

0.6.5

4 files

0.6.4

4 files

0.6.3

4 files

0.6.2

4 files

0.6.1

4 files

0.6

4 files

Pre-release

0.6b1

4 files

0.5.2

4 files

Pre-release

0.5.2b1

4 files

0.5.1

4 files

0.5

4 files

0.4.3

3 files

0.4.2

3 files

0.4.1

3 files

0.4

3 files

0.3

3 files

0.2

3 files

0.1.61950

3 files

0.1.61945

3 files

0.1.61843

3 files

0.1.61798

3 files

0.1.61611

3 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page