# sphinx

> Python documentation generator

- **URL**: https://www.freshcrate.ai/projects/sphinx
- **Author**: pypi
- **Category**: Frameworks
- **Latest version**: `9.1.0` (2026-04-21)
- **License**: Unknown
- **Source**: https://github.com/sphinx-doc/sphinx
- **Homepage**: https://pypi.org/project/Sphinx/
- **Language**: Python
- **GitHub**: 7,783 stars, 2,411 forks
- **Registry**: pypi (`sphinx`)
- **Tags**: `pypi`

## 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/

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `9.1.0` | 2026-04-21 | Low | Imported from PyPI (9.1.0) |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |
| `v9.1.0` | 2025-12-31 | Low | 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 |

## Citation

- HTML: https://www.freshcrate.ai/projects/sphinx
- Markdown: https://www.freshcrate.ai/projects/sphinx.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/sphinx/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._