{"id":26860,"library":"crate-docs-theme","title":"CrateDB Documentation Theme","description":"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.","status":"active","version":"0.50.3","language":"python","source_language":"en","source_url":"https://github.com/crate/crate-docs-theme","tags":["sphinx","documentation","theme","cratedb"],"install":[{"cmd":"pip install crate-docs-theme","lang":"bash","label":"pip"}],"dependencies":[{"reason":"Required theme","package":"sphinx","optional":false},{"reason":"Base theme dependency","package":"sphinx-book-theme","optional":false}],"imports":[{"note":"Use underscore, not hyphen.","wrong":"html_theme = 'crate-docs-theme'","symbol":"html_theme","correct":"html_theme = 'crate_docs_theme'"}],"quickstart":{"code":"# conf.py\nimport os\n\n# Set the documentation theme\nhtml_theme = 'crate_docs_theme'\n\n# Optional: set project-specific config if needed\nhtml_theme_options = {\n    'repository_url': os.environ.get('REPO_URL', 'https://github.com/crate/crate'),\n    'use_repository_button': True,\n}\n","lang":"python","description":"Basic Sphinx config to use crate-docs-theme."},"warnings":[{"fix":"Update to 0.46.0 or later for re-added TOC navigation with state persistence.","message":"The 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.","severity":"breaking","affected_versions":"0.44.0 - 0.46.0"},{"fix":"In conf.py, use: html_theme = 'crate_docs_theme'","message":"The 'crate_docs_theme' import path is the only correct one. Older versions may have used a different name; always use underscore.","severity":"deprecated","affected_versions":"all"},{"fix":"Avoid overriding theme CSS unless you carefully inspect the stack.","message":"The 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Use the simplified stepper syntax introduced in 0.48.0.","message":"When using the 'stepper' directive, the syntax changed in 0.48.0. Older documentation may reference the previous, more verbose syntax.","severity":"gotcha","affected_versions":"<0.48.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Ensure crate-docs-theme is installed: pip install crate-docs-theme. In conf.py, use exactly: html_theme = 'crate_docs_theme' (underscore, not hyphen).","cause":"Misspelled theme name or not installed.","error":"Theme 'crate_docs_theme' not found"},{"fix":"Install all dependencies: pip install crate-docs-theme sphinx-book-theme (or let pip resolve).","cause":"Missing transitive dependency sphinx-book-theme.","error":"No module named 'sphinx_book_theme'"},{"fix":"Upgrade to crate-docs-theme >=0.48.0 to support Sphinx 9.","cause":"Older crate-docs-theme did not support Sphinx 9.","error":"Sphinx version 9.x incompatible"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}