Repository files navigation

This is the theme for the Python documentation.It requires Python 3.12 or newer and Sphinx 7.3 or newer.

Note that when adopting this theme, you're also borrowing an element of thetrust and credibility established by the CPython core developers over theyears. That's fine, and you're welcome to do so for other Python communityprojects if you so choose, but please keep in mind that in doing so you're alsochoosing to accept some of the responsibility for maintaining that collectivetrust.

To use the theme, install it into your docs build environment viapip(preferably in a virtual environment).

To use this theme, add the following toconf.py:

• html_theme = 'python_docs_theme'

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

See a demo of the CPython docs using this theme:

• https://python-docs-theme-previews.readthedocs.io

The kitchen sink is a showcase of every Sphinx feature:

• https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/