Python Docs Sphinx Theme

This is the theme for the Python documentation.

choosing to accept some of the responsibility for maintaining that collective

trust.

To use the theme, install it into your docs build environment via ``pip``

To use the theme, install it into your docs build environment via`pip`

(preferably in a virtual environment).

Configuration options

To use this theme, add the following to ``conf.py``:

To use this theme, add the following to`conf.py`:

- ``html_theme = 'python_docs_theme'``

- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars

-`html_sidebars`, defaults taken fromhttps://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars

Preview

See a demo of the CPython docs using this theme:

The kitchen sink is a showcase of every Sphinx feature:

name ="python-docs-theme"

version ="2024.3"

description ="The Sphinx theme for the CPython docs and related projects"

readme ="README.rst"

readme ="README.md"

license.file ="LICENSE"

authors = [{name ="PyPA",email ="distutils-sig@python.org"}]

requires-python =">=3.8"