Metadata-Version: 2.1
Name: python-docs-theme
Version: 2024.10
Summary: The Sphinx theme for the CPython docs and related projects
Author-email: PyPA <distutils-sig@python.org>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Project-URL: Code, https://github.com/python/python-docs-theme
Project-URL: Download, https://pypi.org/project/python-docs-theme/
Project-URL: Homepage, https://github.com/python/python-docs-theme/
Project-URL: Issue tracker, https://github.com/python/python-docs-theme/issues

# Python Docs Sphinx Theme

This is the theme for the Python documentation.

Note that when adopting this theme, you're also borrowing an element of the
trust and credibility established by the CPython core developers over the
years. That's fine, and you're welcome to do so for other Python community
projects if you so choose, but please keep in mind that in doing so you're also
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`
(preferably in a virtual environment).


## Configuration options

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

## Preview

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/

