Python documentation generator
Project Links
Meta
Author: Adam Turner, Georg Brandl
Requires Python: >=3.11
Classifiers
Development Status
- 5 - Production/Stable
Environment
- Console
- Web Environment
Intended Audience
- Developers
- Education
- End Users/Desktop
- Information Technology
- Other Audience
- Science/Research
- System Administrators
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3 :: Only
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
Framework
- Sphinx
- Sphinx :: Domain
- Sphinx :: Extension
- Sphinx :: Theme
Topic
- Documentation
- Documentation :: Sphinx
- Education
- Internet :: WWW/HTTP :: Site Management
- Internet :: WWW/HTTP :: Site Management :: Link Checking
- Printing
- Software Development
- Software Development :: Documentation
- Text Editors :: Documentation
- Text Processing
- Text Processing :: General
- Text Processing :: Indexing
- Text Processing :: Markup
- Text Processing :: Markup :: HTML
- Text Processing :: Markup :: LaTeX
- Text Processing :: Markup :: Markdown
- Text Processing :: Markup :: reStructuredText
- Text Processing :: Markup :: XML
- Utilities
Typing
- Typed
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.
8.3.0
Mar 02, 2025
8.2.3
Mar 02, 2025
8.2.2
Mar 02, 2025
8.2.1
Feb 21, 2025
8.2.0
Feb 18, 2025
8.2.0rc2
Feb 18, 2025
8.2.0rc1
Feb 16, 2025
8.1.3
Oct 13, 2024
8.1.2
Oct 12, 2024
8.1.1
Oct 11, 2024
8.1.0
Oct 10, 2024
8.0.2
Jul 30, 2024
8.0.1
Jul 30, 2024
8.0.0
Jul 29, 2024
8.0.0rc1
Jul 24, 2024
7.4.7
Jul 20, 2024
7.4.6
Jul 18, 2024
7.4.5
Jul 16, 2024
7.4.4
Jul 15, 2024
7.4.3
Jul 15, 2024
7.4.2
Jul 15, 2024
7.4.1
Jul 15, 2024
7.4.0
Jul 15, 2024
7.3.7
Apr 19, 2024
7.3.6
Apr 17, 2024
7.3.5
Apr 17, 2024
7.3.4
Apr 17, 2024
7.3.3
Apr 17, 2024
7.3.2
Apr 17, 2024
7.3.1
Apr 17, 2024
7.3.0
Apr 16, 2024
7.2.6
Sep 13, 2023
7.2.5
Aug 30, 2023
7.2.4
Aug 28, 2023
7.2.3
Aug 23, 2023
7.2.2
Aug 17, 2023
7.2.1
Aug 17, 2023
7.2.0
Aug 17, 2023
7.1.2
Aug 02, 2023
7.1.1
Jul 27, 2023
7.1.0
Jul 24, 2023
7.0.1
May 12, 2023
7.0.0
Apr 29, 2023
7.0.0rc1
Apr 28, 2023
6.2.1
Apr 25, 2023
6.2.0
Apr 23, 2023
6.1.3
Jan 10, 2023
6.1.2
Jan 07, 2023
6.1.1
Jan 05, 2023
6.1.0
Jan 05, 2023
6.0.1
Jan 05, 2023
6.0.0
Dec 29, 2022
6.0.0b2
Oct 17, 2022
6.0.0b1
Oct 16, 2022
5.3.0
Oct 16, 2022
5.2.3
Sep 30, 2022
5.2.2
Sep 27, 2022
5.2.1
Sep 25, 2022
5.2.0.post0
Sep 24, 2022
5.2.0
Sep 24, 2022
5.1.1
Jul 26, 2022
5.1.0
Jul 24, 2022
5.0.2
Jun 16, 2022
5.0.1
Jun 02, 2022
5.0.0
May 29, 2022
5.0.0b1
May 08, 2022
4.5.0
Mar 27, 2022
4.4.0
Jan 16, 2022
4.3.2
Dec 19, 2021
4.3.1
Nov 27, 2021
4.3.0
Nov 10, 2021
4.2.0
Sep 12, 2021
4.1.2
Jul 26, 2021
4.1.1
Jul 14, 2021
4.1.0
Jul 11, 2021
4.0.3
Jul 05, 2021
4.0.2
May 20, 2021
4.0.1
May 10, 2021
4.0.0
May 09, 2021
4.0.0b2
Apr 29, 2021
4.0.0b1
Apr 11, 2021
3.5.4
Apr 11, 2021
3.5.3
Mar 20, 2021
3.5.2
Mar 06, 2021
3.5.1
Feb 16, 2021
3.5.0
Feb 14, 2021
3.4.3
Jan 07, 2021
3.4.2
Jan 04, 2021
3.4.1
Dec 24, 2020
3.4.0
Dec 20, 2020
3.3.1
Nov 12, 2020
3.3.0
Nov 02, 2020
3.2.1
Aug 14, 2020
3.2.0
Aug 08, 2020
3.1.2
Jul 05, 2020
3.1.1
Jun 14, 2020
3.1.0
Jun 08, 2020
3.0.4
May 26, 2020
3.0.3
Apr 26, 2020
3.0.2
Apr 19, 2020
3.0.1
Apr 10, 2020
3.0.0
Apr 05, 2020
3.0.0b1
Mar 22, 2020
2.4.5
Nov 17, 2021
2.4.4
Mar 05, 2020
2.4.3
Feb 22, 2020
2.4.2
Feb 18, 2020
2.4.1
Feb 11, 2020
2.4.0
Feb 09, 2020
2.3.1
Dec 22, 2019
2.3.0
Dec 15, 2019
2.2.2
Dec 02, 2019
2.2.1
Oct 26, 2019
2.2.0
Aug 18, 2019
2.1.2
Jun 19, 2019
2.1.1
Jun 10, 2019
2.1.0
Jun 02, 2019
2.0.1
Apr 08, 2019
2.0.0
Mar 28, 2019
2.0.0b2
Mar 20, 2019
2.0.0b1
Feb 17, 2019
1.8.6
Nov 17, 2021
1.8.5
Mar 10, 2019
1.8.4
Feb 03, 2019
1.8.3
Dec 25, 2018
1.8.2
Nov 11, 2018
1.8.1
Sep 22, 2018
1.8.0
Sep 12, 2018
1.8.0b1
Aug 20, 2018
1.7.9
Sep 05, 2018
1.7.8
Aug 28, 2018
1.7.7
Aug 19, 2018
1.7.6
Jul 16, 2018
1.7.5
May 28, 2018
1.7.4
Apr 25, 2018
1.7.3
Apr 22, 2018
1.7.2
Mar 21, 2018
1.7.1
Feb 23, 2018
1.7.0
Feb 12, 2018
1.7.0b2
Jan 31, 2018
1.7.0b1
Jan 15, 2018
1.6.7
Feb 04, 2018
1.6.6
Jan 08, 2018
1.6.5
Oct 23, 2017
1.6.4
Sep 26, 2017
1.6.3
Jul 02, 2017
1.6.2
May 28, 2017
1.6.1
May 16, 2017
1.6b3
May 07, 2017
1.6b2
Apr 29, 2017
1.6b1
Apr 23, 2017
1.5.6
May 14, 2017
1.5.5
Apr 03, 2017
1.5.4
Apr 02, 2017
1.5.3
Feb 26, 2017
1.5.2
Jan 22, 2017
1.5.1
Dec 13, 2016
1.5
Dec 05, 2016
1.5b1
Nov 06, 2016
1.5a2
Oct 17, 2016
1.5a1
Sep 21, 2016
1.4.9
Nov 23, 2016
1.4.8
Oct 01, 2016
1.4.7
Oct 01, 2016
1.4.6
Aug 20, 2016
1.4.5
Jul 13, 2016
1.4.4
Jun 12, 2016
1.4.3
Jun 05, 2016
1.4.2
May 29, 2016
1.4.1
Apr 12, 2016
1.4
Mar 28, 2016
1.4b1
Mar 06, 2016
1.4a1
Feb 14, 2016
1.3.6
Feb 29, 2016
1.3.5
Jan 24, 2016
1.3.4
Jan 12, 2016
1.3.3
Dec 02, 2015
1.3.2
Nov 29, 2015
1.3.1
Mar 17, 2015
1.3
Mar 10, 2015
1.3b3
Feb 24, 2015
1.3b2
Dec 05, 2014
1.3b1
Oct 09, 2014
1.2.3
Sep 01, 2014
1.2.2
Mar 02, 2014
1.2.1
Jan 19, 2014
1.2
Dec 10, 2013
1.2b3
Oct 03, 2013
1.2b2
Sep 17, 2013
1.2b1
Mar 31, 2013
1.1.3
Mar 10, 2012
1.1.2
Nov 01, 2011
1.1.1
Nov 01, 2011
1.1
Oct 09, 2011
1.0.8
Sep 23, 2011
1.0.7
Jan 15, 2011
1.0.6
Jan 04, 2011
1.0.5
Nov 12, 2010
1.0.4
Sep 17, 2010
1.0.3
Aug 23, 2010
1.0.2
Aug 14, 2010
1.0.1
Jul 27, 2010
1.0
Jul 23, 2010
1.0b2
May 30, 2010
1.0b1
May 25, 2010
0.6.7
Jun 05, 2010
0.6.6
May 25, 2010
0.6.5
Mar 01, 2010
0.6.4
Jan 12, 2010
0.6.3
Sep 04, 2009
0.6.2
Jun 16, 2009
0.6.1
Mar 26, 2009
0.6
Mar 24, 2009
0.6b1
Mar 16, 2009
0.5.2
Mar 24, 2009
0.5.2b1
Mar 16, 2009
0.5.1
Dec 15, 2008
0.5
Nov 23, 2008
0.4.3
Oct 08, 2008
0.4.2
Jul 29, 2008
0.4.1
Jul 05, 2008
0.4
Jun 23, 2008
0.3
May 06, 2008
0.2
Apr 27, 2008
0.1.61950
Mar 26, 2008
0.1.61945
Mar 26, 2008
0.1.61843
Mar 24, 2008
0.1.61798
Mar 23, 2008
0.1.61611
Mar 21, 2008
0.0rc0
Mar 21, 2008
Wheel compatibility matrix
Files in release
Extras:
Dependencies:
sphinxcontrib-applehelp
(>=1.0.7)
sphinxcontrib-devhelp
(>=1.0.6)
sphinxcontrib-htmlhelp
(>=2.0.6)
sphinxcontrib-jsmath
(>=1.0.1)
sphinxcontrib-qthelp
(>=1.0.6)
sphinxcontrib-serializinghtml
(>=1.1.9)
Jinja2
(>=3.1)
Pygments
(>=2.17)
docutils
(<0.22,>=0.20)
snowballstemmer
(>=2.2)
babel
(>=2.13)
alabaster
(>=0.7.14)
imagesize
(>=1.3)
requests
(>=2.30.0)
roman-numerals-py
(>=1.0.0)
packaging
(>=23.0)
colorama
(>=0.4.6)