The Sphinx theme for the CPython docs and related projects
Project description
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:
The kitchen sink is a showcase of every Sphinx feature:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python_docs_theme-2024.6.tar.gz.
File metadata
- Download URL: python_docs_theme-2024.6.tar.gz
- Upload date:
- Size: 16.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 40492890c77db34120d294c8b0eb2b9f217592d014cc4104d5d2a297c3af7574 |
|
| MD5 | d4720ebbb3e3d03738709e4aadb26ff1 |
|
| BLAKE2b-256 | 1471917008ed9af4b7571f3201495d00db4c6a48eda3b883b001e04f7f6f70b4 |
Provenance
File details
Details for the file python_docs_theme-2024.6-py3-none-any.whl.
File metadata
- Download URL: python_docs_theme-2024.6-py3-none-any.whl
- Upload date:
- Size: 19.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 36e38f0f5b227acfe267b54807b1cf93d6047e8f765bb338af50f1e8fb4423bb |
|
| MD5 | 5b2d426345c7c361a76d9dd89e981025 |
|
| BLAKE2b-256 | 3a7a29dea47fc939994672c58ae5c31be30e57b84c9bb1b61e17e81f980c6f61 |
