Skip to main content

Python documentation generator

Project description

Package on PyPI Build Status Documentation Status BSD 2 Clause

Sphinx makes it easy to create intelligent and beautiful documentation.

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.

Features

  • Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more

  • 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 highlighting: automatic highlighting using the Pygments highlighter

  • Templating: Flexible HTML output using the Jinja 2 templating engine

  • Extension ecosystem: Many extensions are available, for example for automatic function documentation or working with Jupyter notebooks.

  • Language Support: Python, C, C++, JavaScript, mathematics, and many other languages through extensions.

For more information, refer to the the documentation.

Installation

The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

pip install -U sphinx

Contributing

We appreciate all contributions! Refer to the contributors guide for information.

Release signatures

Releases are signed with following keys:

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Sphinx-6.0.0.tar.gz (6.7 MB view details)

Uploaded Source

Built Distribution

sphinx-6.0.0-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Sphinx-6.0.0.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for Sphinx-6.0.0.tar.gz
Algorithm Hash digest
SHA256 58c140ecd9aa0abbc8ff6da48a266648eac9e5bfc8e49576efd2979bf46f5961
MD5 8a48c5319ec1dd6357c0730e6ec01014
BLAKE2b-256 46ddafcd33ecf25b04b6b18bfd7cedf635875fbe9b06de28268e81ecede904eb

See more details on using hashes here.

File details

Details for the file sphinx-6.0.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx-6.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for sphinx-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2aeebfcb0e7474f5a820eac6177c7492b1d3c9c535aa21d5ae77cab2f3600e4
MD5 81a46e28994411a8c125fbec853782d4
BLAKE2b-256 d4a383304f734ba5b5b400af0de3d31d1844ea295c1652435668c9aa2b8650c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page