|
|
||
|---|---|---|
| .github | ||
| python_docs_theme | ||
| .babel.cfg | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .readthedocs.yml | ||
| babel_runner.py | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| pyproject.toml | ||
| README.md | ||
| requirements.txt | ||
Python Docs Sphinx Theme
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 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
Translation
This theme supports localization. For more information see the Python Developer's Guide.
Preview
See a demo of the CPython docs using this theme:
The kitchen sink is a showcase of every Sphinx feature: