Description
======== Sphinx ======== .. image:: https://img.shields.io/pypi/v/sphinx.svg :target: https://pypi.org/project/Sphinx/ :alt: Package on PyPI .. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml :alt: Build Status .. image:: https://readthedocs.org/projects/sphinx/badge/?version=master :target: https://www.sphinx-doc.org/ :alt: Documentation Status .. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg :target: https://opensource.org/licenses/BSD-2-Clause :alt: 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 documentation`_. Installation ============ The following command installs Sphinx from the `Python Package Index`_. You will need a working installation of Python and pip. .. code-block:: shell pip install -U sphinx Contributing ============ We appreciate all contributions! Refer to `the contributors guide`_ for information. .. _the documentation: https://www.sphinx-doc.org/ .. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html .. _Python Package Index: https://pypi.org/project/Sphinx/
Release History
| Version | Changes | Urgency | Date |
|---|---|---|---|
| 9.1.0 | Imported from PyPI (9.1.0) | Low | 4/21/2026 |
| v9.1.0 | Changelog: https://www.sphinx-doc.org/en/master/changes.html Dependencies ------------ * #14153: Drop Python 3.11 support. * #12555: Drop Docutils 0.20 support. Patch by Adam Turner Features added -------------- * Add `add_static_dir()` for copying static assets from extensions to the build output. Patch by Jared Dillard Bugs fixed ---------- * #14189: autodoc: Fix duplicate ``:no-index-entry:`` for modules. Patch by Adam Turner * #13713: Fix compatibility with | Low | 12/31/2025 |
| v9.1.0rc2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 12/27/2025 |
| v9.1.0rc1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 12/19/2025 |
| v9.0.4 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html Bugs fixed ---------- * #14143: Fix spurious build warnings when translators reorder references in strings, or use translated display text in references. Patch by Matt Wang. | Low | 12/4/2025 |
| v9.0.3 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html Bugs fixed ---------- * #14142: autodoc: Restore some missing exports in `sphinx.ext.autodoc`. Patch by Adam Turner. | Low | 12/4/2025 |
| v9.0.2 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html Bugs fixed ---------- * #14142: autodoc: Restore `sphinx.ext.autodoc.mock`. Patch by Adam Turner. | Low | 12/3/2025 |
| v9.0.1 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html Bugs fixed ---------- * #13942: autodoc: Restore the mapping interface for options objects. Patch by Adam Turner. * #13942: autodoc: Deprecate the mapping interface for options objects. Patch by Adam Turner. * #13387: Update translations. | Low | 12/1/2025 |
| v9.0.0 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html Dependencies ------------ * #13786: Support [Docutils 0.22](https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29). Patch by Adam Turner. Incompatible changes -------------------- * #13639: `SphinxComponentRegistry.create_source_parser` no longer has an *app* parameter, instead taking *config* and *env*. Patch by Adam Turner. * #13679: Non-decodable characters in source files now raise an | Low | 11/30/2025 |
| v9.0.0rc4 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html | Low | 11/30/2025 |
| v9.0.0rc3 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html | Low | 11/30/2025 |
| v9.0.0rc2 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html | Low | 11/29/2025 |
| v9.0.0rc1 | Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html | Low | 11/28/2025 |
| v8.2.3 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html | Low | 3/2/2025 |
| v8.2.2 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html | Low | 3/2/2025 |
| v8.2.1 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html | Low | 2/21/2025 |
| v8.2.0 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html Dependencies ------------ * #13000: Drop Python 3.10 support. Incompatible changes -------------------- * #13044: Remove the internal and undocumented ``has_equations`` data from the `MathDomain` domain. The undocumented `MathDomain.has_equations` method now unconditionally returns ``True``. These are replaced by the ``has_maths_elements`` key of the page context dict. Patch by Adam Turner. * #13227: | Low | 2/18/2025 |
| v8.2.0rc2 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html | Low | 2/18/2025 |
| v8.2.0rc1 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html | Low | 2/16/2025 |
| v8.1.3 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html Bugs fixed ---------- * #13013: Restore support for `cut_lines()` with no object type. Patch by Adam Turner. | Low | 10/13/2024 |
| v8.1.2 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html Bugs fixed ---------- * #13012: Expose `sphinx.errors.ExtensionError` in ``sphinx.util`` for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in ``sphinx.util`` was never intentional. `ExtensionError` has been part of ``sphinx.errors`` since Sphinx 0.9. Patch by Adam Turner. | Low | 10/12/2024 |
| v8.1.1 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html Bugs fixed ---------- * #13006: Use the preferred https://www.cve.org/ URL for the ``:cve:`` role. Patch by Hugo van Kemenade. * #13007: LaTeX: Improve resiliency when the required ``fontawesome`` or ``fontawesome5`` packages are not installed. Patch by Jean-François B. | Low | 10/11/2024 |
| v8.1.0 | Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html Dependencies ------------ * #12756: Add lower-bounds to the ``sphinxcontrib-*`` dependencies. Patch by Adam Turner. * #12833: Update the LaTeX ``parskip`` package from 2001 to 2018. Patch by Jean-François B. Incompatible changes -------------------- * #12763: Remove unused internal class ``sphinx.util.Tee``. Patch by Adam Turner. * #12822: LaTeX: for Unicode engines, the `fvset` default is changed to ``' | Low | 10/10/2024 |
| v8.0.2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/30/2024 |
| v8.0.1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/30/2024 |
| v8.0.0 | Changelog: https://www.sphinx-doc.org/en/master/changes.html Dependencies ------------ * #12633: Drop Python 3.9 support. Incompatible changes -------------------- * Remove deprecated functions from ``sphinx.util``: * Removed ``sphinx.util.path_stabilize`` (use ``sphinx.util.osutil.path_stabilize``). * Removed ``sphinx.util.display_chunk`` (use ``sphinx.util.display.display_chunk``). * Removed ``sphinx.util.status_iterator`` (use ``sphinx.util.display.stat | Low | 7/29/2024 |
| v8.0.0rc1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html Dependencies ------------ * #12633: Drop Python 3.9 support. Incompatible changes -------------------- * Remove deprecated functions from ``sphinx.util``: * Removed ``sphinx.util.path_stabilize`` (use ``sphinx.util.osutil.path_stabilize``). * Removed ``sphinx.util.display_chunk`` (use ``sphinx.util.display.display_chunk``). * Removed ``sphinx.util.status_iterator`` (use ``sphinx.util.display.st | Low | 7/24/2024 |
| v7.4.7 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/20/2024 |
| v7.4.6 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/18/2024 |
| v7.4.5 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/16/2024 |
| v7.4.4 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/15/2024 |
| v7.4.3 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/15/2024 |
| v7.4.2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/15/2024 |
| v7.4.1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/15/2024 |
| v7.4.0 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 7/15/2024 |
| v7.3.7 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/19/2024 |
| v7.3.6 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.5 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.4 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.3 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/17/2024 |
| v7.3.0 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 4/16/2024 |
| v7.2.6 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 9/13/2023 |
| v7.2.5 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/30/2023 |
| v7.2.4 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/28/2023 |
| v7.2.3 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/23/2023 |
| v7.2.2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/17/2023 |
| v7.2.1 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/17/2023 |
| v7.2.0 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/17/2023 |
| v7.1.2 | Changelog: https://www.sphinx-doc.org/en/master/changes.html | Low | 8/2/2023 |