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?

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

6 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for amotl from gravatar.com amotl Avatar for bmunkholm from gravatar.com bmunkholm Avatar for Mathias.Fussenegger from gravatar.com Mathias.Fussenegger
+3 more Avatar for matriv from gravatar.com matriv Avatar for smu from gravatar.com smu Avatar for walbeh from gravatar.com walbeh

Credits

Author: Crate.IO GmbH

License

Apache License 2.0

Requires

Python >=3.9

Tags

cratedb docs sphinx readthedocs

Classifiers

Report project as malware

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

6 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for amotl from gravatar.com amotl Avatar for bmunkholm from gravatar.com bmunkholm Avatar for Mathias.Fussenegger from gravatar.com Mathias.Fussenegger
+3 more Avatar for matriv from gravatar.com matriv Avatar for smu from gravatar.com smu Avatar for walbeh from gravatar.com walbeh

Credits

Author: Crate.IO GmbH

License

Apache License 2.0

Requires

Python >=3.9

Tags

cratedb docs sphinx readthedocs

Classifiers

Report project as malware

Release files for crate-docs-theme 0.50.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crate-docs-theme 0.50.3
File Size Uploaded
crate_docs_theme-0.50.3.tar.gz 2.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for crate-docs-theme 0.50.3
File Interpreter ABI Platform
crate_docs_theme-0.50.3-py3-none-any.whl 2.2 MB Python 3 none any Details

Total release size: 4.3 MB

Release files / crate_docs_theme-0.50.3.tar.gz

Download URL crate_docs_theme-0.50.3.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums 		586ac4183a9e35e7a2ca0bb392fcac6245e5a4e3a9d4646cc3d600467dfe0496
BLAKE2b-256 checksum
How to use checksums 		f2a057670a2d91fbbad85e59b82053f61b8579be65ef0691338f0f11671cb95e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.14.3

Release files / crate_docs_theme-0.50.3-py3-none-any.whl

Download URL crate_docs_theme-0.50.3-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums 		08dc68a2cf65a91e2fb65fbb6ef0e5a2bfc1f173b4deccd4c2ff64df9105410d
BLAKE2b-256 checksum
How to use checksums 		5a561547249b28f512e6954dfd7a489a690b7bd9937b2ad1913fba2263d96680
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.14.3

Release history Release notifications | RSS feed

This release

0.50.3 This release

2 release files

0.50.2

2 release files

0.50.1

2 release files

Yanked

0.50.0

2 release files

Yanked reason: broken

Pre-release

0.50.0.dev0

2 release files

0.49.1

2 release files

0.49.0

2 release files

Pre-release

0.49.0.dev0

2 release files

0.48.0

2 release files

Pre-release

0.47.1.dev6

2 release files

Pre-release

0.47.1.dev5

2 release files

Pre-release

0.47.1.dev4

2 release files

Pre-release

0.47.1.dev3

2 release files

Pre-release

0.47.1.dev2

2 release files

Pre-release

0.47.1.dev1

2 release files

Pre-release

0.47.1.dev0

2 release files

0.47.0

2 release files

Yanked

0.46.0

2 release files

Yanked reason: breaks TOC navigation

Yanked

0.45.0

2 release files

Yanked reason: Parsing problems at CrateDB's appendices/compliance.rst:7

Yanked

0.44.0

2 release files

Yanked reason: Navigation bar looks odd.

Yanked

0.43.0

2 release files

Yanked reason: Broken release.

0.42.0

2 release files

0.41.0

2 release files

Pre-release

0.41.0.dev2

2 release files

Pre-release

0.41.0.dev1

2 release files

Pre-release

0.41.0.dev0

2 release files

0.40.1

2 release files

0.40.0

2 release files

Pre-release

0.40.0.dev0

2 release files

0.39.0

2 release files

0.38.6

2 release files

0.38.5

2 release files

0.38.4

2 release files

Pre-release

0.38.4.dev1

2 release files

Pre-release

0.38.4.dev0

2 release files

0.38.3

2 release files

0.38.2

2 release files

Pre-release

0.38.2.dev1

2 release files

Pre-release

0.38.2.dev0

2 release files

Yanked

0.38.1

2 release files

Yanked reason: https://github.com/crate/crate-docs-theme/issues/586

0.38.0

2 release files

Pre-release

0.38.0.dev0

2 release files

0.37.2

2 release files

Pre-release

0.37.2.dev0

2 release files

0.37.1

2 release files

Pre-release

0.37.1.dev0

2 release files

Yanked

0.37.0

2 release files

Yanked reason: Dark theme causes flickering.

Pre-release

0.37.0.dev0

2 release files

0.36.1

2 release files

0.36.0

2 release files

Pre-release

0.35.1.dev0

2 release files

0.35.0

2 release files

Pre-release

0.35.0.dev4

2 release files

Pre-release

0.35.0.dev3

2 release files

Pre-release

0.35.0.dev2

2 release files

Pre-release

0.35.0.dev1

2 release files

0.34.1

2 release files

0.34.0

2 release files

Pre-release

0.34.0.dev6

2 release files

Pre-release

0.34.0.dev5

2 release files

Pre-release

0.34.0.dev4

2 release files

Pre-release

0.34.0.dev3

2 release files

Pre-release

0.34.0.dev2

2 release files

Pre-release

0.34.0.dev1

2 release files

0.33.2

2 release files

0.33.1

2 release files

Pre-release

0.33.1.dev0

2 release files

0.33.0

2 release files

0.32.4

2 release files

Pre-release

0.32.4.dev2

2 release files

Pre-release

0.32.4.dev1

2 release files

Pre-release

0.32.4.dev0

2 release files

0.32.3

2 release files

0.32.2

2 release files

0.32.1

2 release files

0.32.0

2 release files

Pre-release

0.32.0.dev16

2 release files

Pre-release

0.32.0.dev15

2 release files

Pre-release

0.32.0.dev14

2 release files

Pre-release

0.32.0.dev13

2 release files

Pre-release

0.32.0.dev12

2 release files

Pre-release

0.32.0.dev11

2 release files

Pre-release

0.32.0.dev10

2 release files

Pre-release

0.32.0.dev9

2 release files

Pre-release

0.32.0.dev8

2 release files

Pre-release

0.32.0.dev7

2 release files

Pre-release

0.32.0.dev6

2 release files

Pre-release

0.32.0.dev5

2 release files

Pre-release

0.32.0.dev4

2 release files

Pre-release

0.32.0.dev3

2 release files

Pre-release

0.32.0.dev2

2 release files

Pre-release

0.32.0.dev1

2 release files

Pre-release

0.32.0.dev0

2 release files

0.31.2

2 release files

0.31.1

2 release files

0.31.0

2 release files

0.30.0

2 release files

Pre-release

0.30.0.dev8

2 release files

Pre-release

0.30.0.dev7

2 release files

Pre-release

0.30.0.dev6

2 release files

Pre-release

0.30.0.dev5

2 release files

Pre-release

0.30.0.dev4

2 release files

Pre-release

0.30.0.dev3

2 release files

Pre-release

0.30.0.dev2

2 release files

Pre-release

0.30.0.dev1

2 release files

0.29.10

2 release files

0.29.9

2 release files

0.29.8

2 release files

0.29.7

2 release files

0.29.6

2 release files

0.29.5

2 release files

0.29.4

2 release files

0.29.3

2 release files

0.29.2

2 release files

0.29.1

2 release files

0.29.0

2 release files

Pre-release

0.29.0.dev1

2 release files

0.28.2

2 release files

0.28.1

2 release files

Yanked

0.28.0

2 release files

Yanked reason: Discovered a few regressions.

0.27.1

2 release files

0.27.0

2 release files

0.26.5

2 release files

Yanked

0.26.4

2 release files

Yanked reason: Wheel is too small and does not contain bundle artefacts.

0.26.3

2 release files

0.26.2

2 release files

0.26.1

2 release files

0.26.0

2 release files

0.25.0

2 release files

Pre-release

0.25.0rc1

2 release files

0.24.5

2 release files

0.24.4

2 release files

0.24.3

2 release files

0.24.2

2 release files

0.24.1

2 release files

0.24.0

2 release files

0.23.0

2 release files

0.22.3

2 release files

0.22.2

2 release files

0.22.1

2 release files

0.22.0

2 release files

0.21.4

2 release files

0.21.3

2 release files

0.21.2

2 release files

0.21.1

2 release files

0.21.0

2 release files

0.20.1

2 release files

0.20.0

2 release files

0.19.1

2 release files

0.19.0

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.15.4

2 release files

0.15.2

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.13.3

2 release files

0.13.2

2 release files

0.13.1

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

Pre-release

0.11.0b2

2 release files

Pre-release

0.11.0b1

2 release files

0.10.17

2 release files

0.10.16

2 release files

0.10.15

2 release files

0.10.14

2 release files

0.10.13

2 release files

0.10.12

2 release files

0.10.11

2 release files

0.10.10

2 release files

0.10.9

2 release files

0.10.8

2 release files

0.10.7

2 release files

0.10.6

2 release files

0.10.5

2 release files

0.10.4

2 release files

0.10.3

2 release files

0.10.2

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.6

2 release files

0.9.5

2 release files

0.9.4

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.5

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.85

2 release files

0.5.84

2 release files

0.5.83

2 release files

0.5.82

2 release files

0.5.81

2 release files

0.5.80

2 release files

0.5.79

2 release files

0.5.78

2 release files

0.5.77

2 release files

0.5.76

2 release files

0.5.74

2 release files

0.5.73

2 release files

0.5.72

2 release files

0.5.71

2 release files

0.5.70

2 release files

0.5.69

2 release files

0.5.68

2 release files

0.5.67

2 release files

0.5.66

2 release files

0.5.65

2 release files

0.5.64

2 release files

0.5.63

2 release files

0.5.62

2 release files

0.5.61

2 release files

0.5.60

2 release files

0.5.59

2 release files

0.5.58

2 release files

0.5.57

2 release files

0.5.56

2 release files

0.5.55

2 release files

0.5.54

2 release files

0.5.53

2 release files

0.5.52

2 release files

0.5.51

2 release files

0.5.48

2 release files

0.5.47

2 release files

0.5.46

2 release files

0.5.45

2 release files

0.5.44

2 release files

0.5.43

2 release files

0.5.42

2 release files

0.5.41

2 release files

0.5.40

2 release files

0.5.39

2 release files

0.5.38

2 release files

0.5.37

2 release files

0.5.36

2 release files

0.5.35

2 release files

0.5.34

2 release files

0.5.33

2 release files

0.5.32

2 release files

0.5.31

2 release files

0.5.30

2 release files

0.5.29

2 release files

0.5.28

2 release files

0.5.27

2 release files

0.5.26

2 release files

0.5.25

2 release files

0.5.24

2 release files

0.5.23

2 release files

0.5.22

2 release files

0.5.21

2 release files

0.5.20

2 release files

0.5.19

1 release file

0.5.18

1 release file

0.5.17

1 release file

0.5.16

1 release file

0.5.15

1 release file

0.5.14

1 release file

0.5.13

1 release file

0.5.12

1 release file

0.5.11

1 release file

0.5.10

1 release file

0.5.9

1 release file

0.5.8

1 release file

0.5.7

1 release file

0.5.6

1 release file

0.5.5

1 release file

0.5.4

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.9

1 release file

0.3.8

1 release file

0.3.7

1 release file

0.3.6

1 release file

0.3.5

1 release file

0.3.4

1 release file

0.3.3

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page