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 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 sphinxContributing
We appreciate all contributions! Refer to the contributors guide for information.
Release files for Sphinx 8.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-8.1.0.tar.gz | 8.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx-8.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.7 MB
Release files / sphinx-8.1.0.tar.gz
| Download URL | sphinx-8.1.0.tar.gz |
|---|---|
| Size | 8.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
109454425dbf4c78ecfdd481e56f078376d077edbda29804dba05c5161c8de06
|
|
BLAKE2b-256 checksum How to use checksums |
9df3e3c6fb6d015d6b0c5215d1a6e45276aa89b6685fc63a1b7ac230bcebcb4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 10, 2024.
Transparency logRelease files / sphinx-8.1.0-py3-none-any.whl
| Download URL | sphinx-8.1.0-py3-none-any.whl |
|---|---|
| Size | 3.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3202bba95697b9fc4371a07d6d457239de9860244ce235283149f817c253fd2f
|
|
BLAKE2b-256 checksum How to use checksums |
fb21143e5e4666432668fbd669f89ee0abc50040787f932bd30befd0f7a42a6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 10, 2024.
Transparency log
