Registry / web-framework / python-docs-theme

python-docs-theme

library2026.4pypypiunverified

The Sphinx theme for the CPython docs and related projects. It provides a clean, responsive design and includes features like a dark mode, code copy buttons, and internationalization support. The library is actively maintained with frequent releases, typically on a monthly or bi-monthly cadence. The current version is 2026.3.

web-framework

pip install python-docs-theme

github ↗package ↗

INSTALL

IMPORT

SIG · PYTHON-DOCS-THEME

python-docs-theme

web-frameworkpythonv2026.4

Install

5.2s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2025.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.2MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 5.2s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

html_theme

✓ html_theme = 'python_docs_theme'

This setting is placed in your Sphinx project's conf.py file to activate the theme.

A basic Sphinx project setup, demonstrating how to enable the `python-docs-theme`. After running `sphinx-quickstart` to create your project structure, edit `conf.py` to set the `html_theme`.

mkdir my_docs cd my_docs sphinx-quickstart # Follow prompts, choose 'y' for separate source/build, 'y' for autodoc # Edit source/conf.py (or conf.py directly if not using separate source/build) # Add or modify the following line: # html_theme = 'python_docs_theme' # Create a simple reStructuredText file (e.g., source/index.rst) # .. toctree:: # :maxdepth: 2 # :caption: Contents: # # intro # Create source/intro.rst # My First Page # ============ # # Hello, world! This is my first page using the Python Docs Theme. make html # or sphinx-build -b html source build

Debug

Known issues

breakingVersion 2025.4 and newer dropped support for Python 3.10 and 3.11.

fix

Upgrade your Python environment to 3.12 or newer, or pin `python-docs-theme<2025.4`.

affects: >=2025.4

breakingVersion 2025.4 and newer requires Sphinx 7.3 or newer.

fix

Upgrade your Sphinx installation to 7.3 or newer, or pin `python-docs-theme<2025.4`.

affects: >=2025.4

gotchaThe behavior of code block copy buttons was enhanced across versions. Initially, they appeared on hover/click (2025.5), then specifically enabled for shell sessions and consoles (2026.2).

fix

Upgrade to `python-docs-theme` 2026.2 or newer to ensure full copy button functionality for all code blocks, including shell and console examples.

affects: <2026.2

gotchaCustom configurations for `html_sidebars`, `html_theme_path`, or `html_theme_config` in `conf.py` can interfere with the theme's default layout and features.

fix

If encountering unexpected layout issues, temporarily comment out or unset these theme-related configurations in `conf.py` to see if they are causing the conflict.

affects: All

Upgrade

Version history

2026.4latest on PyPI · released Apr 19, 2026

Audit

Dependencies

pythonrequiredRequired Python interpreter version for the package.

SphinxrequiredThe theme is built for Sphinx documentation projects.

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/python/python-docs-theme ↗

packagehttps://pypi.org/project/python-docs-theme/ ↗