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

Uploaded Source

Built Distribution

sphinx-5.3.0-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Sphinx-5.3.0.tar.gz
  • Upload date:
  • Size: 6.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for Sphinx-5.3.0.tar.gz
Algorithm Hash digest
SHA256 51026de0a9ff9fc13c05d74913ad66047e104f56a129ff73e174eb5c3ee794b5
MD5 b752f7b0177865a36cbcdcef4ac80cd4
BLAKE2b-256 afb202a43597980903483fe5eb081ee8e0ba2bb62ea43a70499484343795f3bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx-5.3.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for sphinx-5.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 060ca5c9f7ba57a08a1219e547b269fadf125ae25b06b9fa7f66768efb652d6d
MD5 5fe4c2e986a489afafcbfdc7d6425814
BLAKE2b-256 67a701dd6fd9653c056258d65032aa09a615b5d7b07dd840845a9f41a8860fbc

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