# Python Docs Sphinx Theme
This is the theme for the Python documentation.
It requires Python 3.9 or newer and Sphinx 3.4 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
## 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/
Raw data
{
"_id": null,
"home_page": null,
"name": "python-docs-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "PyPA <distutils-sig@python.org>",
"download_url": "https://files.pythonhosted.org/packages/9d/a4/a79cfff5b38fe6517fdbe16f660f7ddc2f8e89d76b0dbb4ab3a792b1a23a/python_docs_theme-2025.2.tar.gz",
"platform": null,
"description": "# Python Docs Sphinx Theme\n\nThis is the theme for the Python documentation.\nIt requires Python 3.9 or newer and Sphinx 3.4 or newer.\n\nNote that when adopting this theme, you're also borrowing an element of the\ntrust and credibility established by the CPython core developers over the\nyears. That's fine, and you're welcome to do so for other Python community\nprojects if you so choose, but please keep in mind that in doing so you're also\nchoosing to accept some of the responsibility for maintaining that collective\ntrust.\n\nTo use the theme, install it into your docs build environment via `pip`\n(preferably in a virtual environment).\n\n\n## Configuration options\n\nTo use this theme, add the following to `conf.py`:\n\n- `html_theme = 'python_docs_theme'`\n\n- `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars\n\n## Preview\n\nSee a demo of the CPython docs using this theme:\n\n- https://python-docs-theme-previews.readthedocs.io\n\nThe kitchen sink is a showcase of every Sphinx feature:\n\n- https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "The Sphinx theme for the CPython docs and related projects",
"version": "2025.2",
"project_urls": {
"Code": "https://github.com/python/python-docs-theme",
"Download": "https://pypi.org/project/python-docs-theme/",
"Homepage": "https://github.com/python/python-docs-theme/",
"Issue tracker": "https://github.com/python/python-docs-theme/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8935ada3da59ed82c35103f76a570eee18005d73cffb7209330e08c1effeb4ed",
"md5": "41efb725fa91d1293172451af6e28604",
"sha256": "6f2b234d5521d7a23eb91f3f597d99a3cc2c832ab764e23a4aaa245f5bd1e65b"
},
"downloads": -1,
"filename": "python_docs_theme-2025.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41efb725fa91d1293172451af6e28604",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20045,
"upload_time": "2025-02-04T14:57:38",
"upload_time_iso_8601": "2025-02-04T14:57:38.312638Z",
"url": "https://files.pythonhosted.org/packages/89/35/ada3da59ed82c35103f76a570eee18005d73cffb7209330e08c1effeb4ed/python_docs_theme-2025.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9da4a79cfff5b38fe6517fdbe16f660f7ddc2f8e89d76b0dbb4ab3a792b1a23a",
"md5": "9628da964e23a2e52c3bf7f920897aaf",
"sha256": "dbf43d771453976a3f49c51c80cb44a9d302156be607d4f729552d95278ee3d8"
},
"downloads": -1,
"filename": "python_docs_theme-2025.2.tar.gz",
"has_sig": false,
"md5_digest": "9628da964e23a2e52c3bf7f920897aaf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17037,
"upload_time": "2025-02-04T14:57:40",
"upload_time_iso_8601": "2025-02-04T14:57:40.375925Z",
"url": "https://files.pythonhosted.org/packages/9d/a4/a79cfff5b38fe6517fdbe16f660f7ddc2f8e89d76b0dbb4ab3a792b1a23a/python_docs_theme-2025.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 14:57:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python",
"github_project": "python-docs-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "Babel",
"specs": []
},
{
"name": "Jinja2",
"specs": []
},
{
"name": "tomli",
"specs": []
}
],
"lcname": "python-docs-theme"
}
JSON
