Skip to main content

CrateDB Documentation Theme

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?

Metadata

Release files for crate-docs-theme 0.51.0

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.51.0
File Size Uploaded Provenance Actions
crate_docs_theme-0.51.0.tar.gz 1.6 MB Without provenance Details for crate_docs_theme-0.51.0.tar.gz

Built distribution (wheel)

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

Total release size: 3.2 MB

Release files / crate_docs_theme-0.51.0.tar.gz

Download URL crate_docs_theme-0.51.0.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
d3969b504508783c6a0213f2d2a83e16381fa4944eb92d6f0f4b1b8f803128c3
BLAKE2b-256 checksum
How to use checksums
c86e24ea6bd325be41cfd6e0cbaf689aa52b1c36d8739c2254c7c2296cd35ae9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.14

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

Download URL crate_docs_theme-0.51.0-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
35e4d8d53f3ac087762ba97f2275c0f451498bc29c43457a17a3813b580624a5
BLAKE2b-256 checksum
How to use checksums
588da333990c60dfeae32fcae484712e1d9bf1c96d579c030fe51f42a1ec64b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.14

Security for crate-docs-theme 0.51.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.51.0 This release

2 release files No provenance

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