crate-docs-theme 0.50.3


pip install crate-docs-theme

  Latest version

Released: Apr 03, 2026
Navigation
Project Links
Meta
Author: Crate.IO GmbH
Requires Python: >=3.9
Classifiers

Intended Audience
  • Developers

Operating System
  • OS Independent

Programming Language
  • Python
  • Python :: 3
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11
  • Python :: 3.12
  • Python :: 3.13
  • Python :: 3.14

Topic
  • Software Development :: Documentation

CI status Read the Docs status PyPI version crate-docs version Python Versions

About

A Sphinx theme for the CrateDB documentation.

Note: This theme is tightly integrated into the cratedb.com website and is not intended for general use.

For making changes to the theme, see the developer docs.

Preview

The demo/preview project is rendered and published to https://crate-docs-theme.readthedocs.io/.

Using the theme

Prerequisites

The documentation can include UML diagrams which will be rendered using sphinxcontrib-plantuml. In order to satisfy its requirements, run:

# On Linux
apt-get install plantuml

# On macOS
brew install plantuml

Installation

The CrateDB Documentation Theme is available as a package on PyPI. However, there is no need to install it yourself. CrateDB projects that use the theme should install it automatically.

Configuration

The documentation is composed of multiple separate documentation projects, interlinked via the CrateDB Documentation Theme.

To update the root of the TOC sidebar for the entire documentation, update the sidebartoc.py file.

To use the theme, add this line to your Sphinx conf.py file:

from crate.theme.rtd.conf.foo import *

Here, replace foo with the appropriate module for your documentation project.

Contributing

This project is primarily maintained by Crate.io, but we welcome community contributions!

See the developer docs and the contribution docs for more information.

Help

Looking for more help?

0.50.3 Apr 03, 2026
0.50.2 Feb 22, 2026
0.50.1 Feb 22, 2026
0.50.0 Feb 20, 2026
0.50.0.dev0 Feb 20, 2026
0.49.1 Feb 12, 2026
0.49.0 Feb 12, 2026
0.49.0.dev0 Feb 11, 2026
0.48.0 Jan 27, 2026
0.47.1.dev6 Jan 21, 2026
0.47.1.dev5 Jan 21, 2026
0.47.1.dev4 Jan 15, 2026
0.47.1.dev3 Jan 15, 2026
0.47.1.dev2 Jan 15, 2026
0.47.1.dev1 Jan 14, 2026
0.47.1.dev0 Jan 14, 2026
0.47.0 Jan 14, 2026
0.46.0 Jan 08, 2026
0.45.0 Dec 19, 2025
0.44.0 Dec 17, 2025
0.43.0 Dec 17, 2025
0.42.0 Nov 05, 2025
0.41.0 Oct 08, 2025
0.41.0.dev2 Oct 08, 2025
0.41.0.dev1 Oct 06, 2025
0.41.0.dev0 Oct 05, 2025
0.40.1 Sep 23, 2025
0.40.0 Sep 18, 2025
0.40.0.dev0 Aug 24, 2025
0.39.0 Jun 25, 2025
0.38.6 Jun 11, 2025
0.38.5 May 08, 2025
0.38.4 Apr 07, 2025
0.38.4.dev1 Apr 07, 2025
0.38.4.dev0 Apr 06, 2025
0.38.3 Mar 20, 2025
0.38.2 Mar 17, 2025
0.38.2.dev1 Mar 17, 2025
0.38.2.dev0 Mar 17, 2025
0.38.1 Mar 07, 2025
0.38.0 Jan 27, 2025
0.38.0.dev0 Jan 24, 2025
0.37.2 Dec 13, 2024
0.37.2.dev0 Nov 29, 2024
0.37.1 Nov 26, 2024
0.37.1.dev0 Nov 25, 2024
0.37.0 Nov 21, 2024
0.37.0.dev0 Nov 14, 2024
0.36.1 Nov 06, 2024
0.36.0 Oct 15, 2024
0.35.1.dev0 Oct 28, 2024
0.35.0 Oct 08, 2024
0.35.0.dev4 Oct 08, 2024
0.35.0.dev3 Oct 08, 2024
0.35.0.dev2 Oct 08, 2024
0.35.0.dev1 Oct 08, 2024
0.34.1 Sep 24, 2024
0.34.0 Aug 07, 2024
0.34.0.dev6 Aug 05, 2024
0.34.0.dev5 Aug 01, 2024
0.34.0.dev4 Jul 31, 2024
0.34.0.dev3 Jul 22, 2024
0.34.0.dev2 Jul 20, 2024
0.34.0.dev1 Jul 18, 2024
0.33.2 Jul 25, 2024
0.33.1 Jul 04, 2024
0.33.1.dev0 Jun 27, 2024
0.33.0 Jul 01, 2024
0.32.4 Jun 14, 2024
0.32.4.dev2 Jun 14, 2024
0.32.4.dev1 Jun 13, 2024
0.32.4.dev0 Jun 13, 2024
0.32.3 May 27, 2024
0.32.2 May 08, 2024
0.32.1 May 07, 2024
0.32.0 May 06, 2024
0.32.0.dev16 May 06, 2024
0.32.0.dev15 May 06, 2024
0.32.0.dev14 May 06, 2024
0.32.0.dev13 May 06, 2024
0.32.0.dev12 May 06, 2024
0.32.0.dev11 May 06, 2024
0.32.0.dev10 May 06, 2024
0.32.0.dev9 May 06, 2024
0.32.0.dev8 May 06, 2024
0.32.0.dev7 May 06, 2024
0.32.0.dev6 May 06, 2024
0.32.0.dev5 May 06, 2024
0.32.0.dev4 May 06, 2024
0.32.0.dev3 May 06, 2024
0.32.0.dev2 May 06, 2024
0.32.0.dev1 May 06, 2024
0.32.0.dev0 May 06, 2024
0.31.2 May 06, 2024
0.31.1 Apr 10, 2024
0.31.0 Apr 06, 2024
0.30.0 Mar 05, 2024
0.30.0.dev8 Mar 04, 2024
0.30.0.dev7 Mar 04, 2024
0.30.0.dev6 Feb 27, 2024
0.30.0.dev5 Feb 22, 2024
0.30.0.dev4 Feb 22, 2024
0.30.0.dev3 Oct 26, 2023
0.30.0.dev2 Oct 26, 2023
0.30.0.dev1 Oct 26, 2023
0.29.10 Jan 25, 2024
0.29.9 Dec 07, 2023
0.29.8 Sep 28, 2023
0.29.7 Sep 19, 2023
0.29.6 Sep 06, 2023
0.29.5 Sep 01, 2023
0.29.4 Aug 30, 2023
0.29.3 Aug 30, 2023
0.29.2 Aug 11, 2023
0.29.1 Aug 08, 2023
0.29.0 Aug 03, 2023
0.29.0.dev1 Aug 03, 2023
0.28.2 Aug 01, 2023
0.28.1 Jul 29, 2023
0.28.0 Jul 28, 2023
0.27.1 May 15, 2023
0.27.0 Apr 18, 2023
0.26.5 Dec 29, 2022
0.26.4 Dec 29, 2022
0.26.3 Sep 05, 2022
0.26.2 Jul 25, 2022
0.26.1 Jul 25, 2022
0.26.0 Jul 22, 2022
0.25.0 Jul 13, 2022
0.25.0rc1 Jul 07, 2022
0.24.5 Jun 23, 2022
0.24.4 May 17, 2022
0.24.3 May 16, 2022
0.24.2 May 16, 2022
0.24.1 May 04, 2022
0.24.0 May 04, 2022
0.23.0 Apr 05, 2022
0.22.3 Mar 31, 2022
0.22.2 Mar 30, 2022
0.22.1 Mar 30, 2022
0.22.0 Mar 29, 2022
0.21.4 Mar 25, 2022
0.21.3 Mar 25, 2022
0.21.2 Mar 01, 2022
0.21.1 Mar 01, 2022
0.21.0 Mar 01, 2022
0.20.1 Feb 15, 2022
0.20.0 Feb 15, 2022
0.19.1 Dec 07, 2021
0.19.0 Dec 06, 2021
0.18.0 Nov 09, 2021
0.17.0 Oct 12, 2021
0.16.1 Aug 26, 2021
0.16.0 Aug 06, 2021
0.15.4 Jun 18, 2021
0.15.2 May 28, 2021
0.15.1 May 27, 2021
0.15.0 May 26, 2021
0.14.1 Mar 18, 2021
0.14.0 Mar 18, 2021
0.13.3 Mar 15, 2021
0.13.2 Mar 15, 2021
0.13.1 Feb 03, 2021
0.13.0 Jan 26, 2021
0.12.0 Dec 01, 2020
0.11.0 Oct 22, 2020
0.11.0b2 Oct 19, 2020
0.11.0b1 Sep 29, 2020
0.10.17 Oct 06, 2020
0.10.16 Sep 17, 2020
0.10.15 Sep 02, 2020
0.10.14 Sep 01, 2020
0.10.13 Aug 31, 2020
0.10.12 Aug 27, 2020
0.10.11 Aug 25, 2020
0.10.10 Aug 25, 2020
0.10.9 Aug 24, 2020
0.10.8 Aug 24, 2020
0.10.7 Aug 20, 2020
0.10.6 Aug 18, 2020
0.10.5 Aug 18, 2020
0.10.4 Aug 04, 2020
0.10.3 Jul 23, 2020
0.10.2 Jul 22, 2020
0.10.1 Jul 20, 2020
0.10.0 Jun 22, 2020
0.9.6 Jun 05, 2020
0.9.5 May 18, 2020
0.9.4 May 06, 2020
0.9.3 May 06, 2020
0.9.2 May 04, 2020
0.9.1 May 04, 2020
0.9.0 Apr 29, 2020
0.8.3 Apr 09, 2020
0.8.2 Mar 31, 2020
0.8.1 Mar 30, 2020
0.8.0 Mar 30, 2020
0.7.5 Jan 22, 2020
0.7.4 Jan 21, 2020
0.7.3 Jan 20, 2020
0.7.2 Dec 19, 2019
0.7.1 Nov 08, 2019
0.7.0 Nov 06, 2019
0.6.0 Oct 01, 2019
0.5.85 Sep 23, 2019
0.5.84 Aug 16, 2019
0.5.83 Jul 24, 2019
0.5.82 Jul 10, 2019
0.5.81 Jul 09, 2019
0.5.80 Jul 05, 2019
0.5.79 Jul 04, 2019
0.5.78 May 27, 2019
0.5.77 May 15, 2019
0.5.76 May 13, 2019
0.5.74 Apr 26, 2019
0.5.73 Apr 12, 2019
0.5.72 Mar 19, 2019
0.5.71 Mar 13, 2019
0.5.70 Feb 04, 2019
0.5.69 Jan 28, 2019
0.5.68 Jan 22, 2019
0.5.67 Dec 10, 2018
0.5.66 Dec 06, 2018
0.5.65 Dec 06, 2018
0.5.64 Nov 27, 2018
0.5.63 Oct 15, 2018
0.5.62 Oct 15, 2018
0.5.61 Oct 15, 2018
0.5.60 Sep 18, 2018
0.5.59 Sep 13, 2018
0.5.58 May 30, 2018
0.5.57 Mar 22, 2018
0.5.56 Mar 01, 2018
0.5.55 Feb 14, 2018
0.5.54 Feb 13, 2018
0.5.53 Feb 13, 2018
0.5.52 Feb 02, 2018
0.5.51 Feb 01, 2018
0.5.48 Nov 08, 2017
0.5.47 Nov 08, 2017
0.5.46 Nov 03, 2017
0.5.45 Oct 26, 2017
0.5.44 Oct 25, 2017
0.5.43 Oct 25, 2017
0.5.42 Oct 09, 2017
0.5.41 Sep 12, 2017
0.5.40 Sep 11, 2017
0.5.39 Sep 05, 2017
0.5.38 Sep 05, 2017
0.5.37 Sep 04, 2017
0.5.36 Sep 01, 2017
0.5.35 Aug 24, 2017
0.5.34 Aug 17, 2017
0.5.33 Aug 01, 2017
0.5.32 Aug 01, 2017
0.5.31 Aug 01, 2017
0.5.30 Aug 01, 2017
0.5.29 Aug 01, 2017
0.5.28 Jul 18, 2017
0.5.27 Jul 18, 2017
0.5.26 Jul 17, 2017
0.5.25 Jul 10, 2017
0.5.24 Jul 03, 2017
0.5.23 May 02, 2017
0.5.22 Apr 25, 2017
0.5.21 Apr 24, 2017
0.5.20 Apr 24, 2017
0.5.19 Apr 24, 2017
0.5.18 Mar 15, 2017
0.5.17 Feb 20, 2017
0.5.16 Jan 16, 2017
0.5.15 Jun 22, 2016
0.5.14 Jun 22, 2016
0.5.13 May 17, 2016
0.5.12 May 03, 2016
0.5.11 Apr 26, 2016
0.5.10 Apr 08, 2016
0.5.9 Apr 05, 2016
0.5.8 Mar 30, 2016
0.5.7 Mar 17, 2016
0.5.6 Mar 16, 2016
0.5.5 Mar 03, 2016
0.5.4 Feb 15, 2016
0.5.3 Feb 11, 2016
0.5.2 Jan 26, 2016
0.5.1 Jan 26, 2016
0.5.0 Jan 26, 2016
0.4.3 Dec 16, 2015
0.4.2 Sep 07, 2015
0.4.1 Jul 17, 2015
0.4.0 Jul 02, 2015
0.3.9 May 26, 2015
0.3.8 Dec 03, 2014
0.3.7 Nov 11, 2014
0.3.6 Sep 05, 2014
0.3.5 Aug 19, 2014
0.3.4 Aug 07, 2014
0.3.3 Aug 05, 2014
0.3.2 Jul 31, 2014
0.3.1 Jul 29, 2014
0.3.0 Jul 28, 2014
0.2.7 Jul 03, 2014
0.2.6 Jul 03, 2014
0.2.5 May 20, 2014
0.2.4 May 19, 2014
0.2.3 May 12, 2014
0.2.2 May 08, 2014
0.2.1 May 08, 2014
0.2.0 May 08, 2014
0.1.0 May 07, 2014

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras: None
Dependencies:
furo (==2025.12.19)
jinja2 (<4,>=3)
jupysql (<0.12)
myst-nb (<1.4)
myst-parser[linkify] (<6)
snowballstemmer (<4)
sphinx (<10,>=7.1)
sphinx-basic-ng (==1.0.0b2)
sphinx-copybutton (<1,>=0.3.1)
sphinx-design-elements (<0.5)
sphinx-inline-tabs
sphinx-sitemap (<2.10.0)
sphinx-togglebutton (<1)
sphinxext.opengraph (<1,>=0.4)
sphinxcontrib-mermaid (<2)
sphinxcontrib-plantuml (<1,>=0.21)
sphinxcontrib-youtube (<2)