Registry / web-framework / crate-docs-theme

crate-docs-theme

library0.50.3pypypiunverified

A Sphinx documentation theme for CrateDB documentation projects. Version 0.50.3, released monthly with minor improvements and dependency updates. Supports Sphinx 9.x and Python >=3.9.

web-framework

pip install crate-docs-theme

github ↗package ↗

INSTALL

IMPORT

SIG · CRATE-DOCS-THEME

crate-docs-theme

web-frameworkpythonv0.50.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

html_theme

✓ html_theme = 'crate_docs_theme'

✗ html_theme = 'crate-docs-theme'

Use underscore, not hyphen.

Basic Sphinx config to use crate-docs-theme.

# conf.py import os # Set the documentation theme html_theme = 'crate_docs_theme' # Optional: set project-specific config if needed html_theme_options = { 'repository_url': os.environ.get('REPO_URL', 'https://github.com/crate/crate'), 'use_repository_button': True, }

Debug

Known issues

breakingThe theme's TOC navigation behavior changed significantly between 0.44.0 and 0.46.0. If you rely on expand/collapse state persistence or custom TOC templates, review the changelog.

fix

Update to 0.46.0 or later for re-added TOC navigation with state persistence.

affects: 0.44.0 - 0.46.0

deprecatedThe 'crate_docs_theme' import path is the only correct one. Older versions may have used a different name; always use underscore.

fix

In conf.py, use: html_theme = 'crate_docs_theme'

affects: all

gotchaThe theme is built on top of sphinx-book-theme, which itself depends on pydata-sphinx-theme. Conflicts can arise if you mix custom CSS from other themes.

fix

Avoid overriding theme CSS unless you carefully inspect the stack.

affects: all

gotchaWhen using the 'stepper' directive, the syntax changed in 0.48.0. Older documentation may reference the previous, more verbose syntax.

fix

Use the simplified stepper syntax introduced in 0.48.0.

affects: <0.48.0

Upgrade

Version history

0.50.3latest on PyPI · released Apr 3, 2026

Audit

Dependencies

sphinxrequiredRequired theme

sphinx-book-themerequiredBase theme dependency

Agent activity

4 hits · last 30 days

node

Resources

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

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