Registry / web-framework / pydata-sphinx-theme

pydata-sphinx-theme

library0.21.0pypypi✓ verified 26d ago

The PyData Sphinx Theme is a clean, three-column, Bootstrap-based Sphinx theme designed for the PyData community. It provides a modern, responsive design with built-in light/dark mode toggling and extensive customization options via `html_theme_options`. Currently at version 0.17.0, the project maintains a regular release cadence, with new versions published frequently (typically monthly or upon significant feature additions/bug fixes).

web-framework devops

pip install pydata-sphinx-theme

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PYDATA-SPHINX-THEM

pydata-sphinx-theme

web-frameworkpythonv0.21.0

Install

5.9s avg

Import

—

Disk

105MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.19.0 · 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.95 runs

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

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.9s · import 0.000s · 103MB

105MB installed

● package 105MB

Code

Verified usage

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

html_theme configuration

✓ html_theme = "pydata_sphinx_theme"

The theme is configured in your Sphinx project's `conf.py` file by setting the `html_theme` variable. There are no direct Python imports from the library for typical usage.

To use the PyData Sphinx Theme, set `html_theme = "pydata_sphinx_theme"` in your `conf.py`. All theme-specific customizations are managed through the `html_theme_options` dictionary. This example also shows how to add an icon link and customize the footer.

# conf.py import os import sys project = 'My Awesome Project' copyright = '2026, My Team' author = 'My Team' release = '0.1' html_theme = "pydata_sphinx_theme" html_theme_options = { "icon_links": [ { "name": "GitHub", "url": "https://github.com/my-org/my-project", "icon": "fa-brands fa-github", "type": "fontawesome", } ], "navbar_persistent": [], # Remove 'search' from persistent navbar "show_prev_next": False, "switcher": { "version_match": "latest", }, "footer_start": ["copyright"], } html_static_path = ['_static'] html_css_files = ['custom.css'] # Example for custom CSS

Debug

Known issues

gotchaNew major versions of Sphinx may not be immediately supported. The PyData Sphinx Theme aims to support the latest Sphinx version that is older than 6 months. Using a very recent Sphinx release might lead to build issues until the theme is updated.

fix

If experiencing issues with a new Sphinx version, try pinning to an older, compatible Sphinx version (e.g., `pip install 'sphinx<6'`) or wait for a theme update. Refer to the theme's official documentation for supported Sphinx versions.

affects: All versions

breakingVersion 0.16.x introduced significant changes, including an upgrade to Bootstrap 5 and the removal of jQuery. This may break custom CSS, JavaScript, or certain theme options that relied on previous versions of Bootstrap (4) or jQuery.

fix

Review the theme's changelog for `v0.16.0` and subsequent releases. Update custom CSS and JavaScript to be compatible with Bootstrap 5 and vanilla JavaScript where jQuery was previously used. Some theme options might have been removed or renamed (e.g., `sidebarwidth` was removed in v0.16.1).

affects: >=0.16.0

gotchaTheme-specific options must be set within the `html_theme_options` dictionary in `conf.py`. Directly defining `html_` variables (e.g., `html_sidebars`, `html_theme_path`, `html_theme_config`) might conflict with or override the theme's internal logic, leading to unexpected layout or functionality.

fix

Always configure theme-specific settings through the `html_theme_options` dictionary. If you need to deeply customize aspects like sidebars, consult the theme's documentation for the correct approach rather than overriding global Sphinx `html_` variables directly.

affects: All versions

Upgrade

Version history

0.21.0latest on PyPI · released Aug 25, 2026

Audit

Dependencies

SphinxrequiredPrimary documentation generation framework. The theme aims to support the latest Sphinx version older than 6 months, but new major Sphinx releases may require a waiting period for full compatibility.

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/pydata/pydata-sphinx-theme ↗

packagehttps://pypi.org/project/pydata-sphinx-theme/ ↗

homepagehttps://pydata-sphinx-theme.readthedocs.io ↗