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.1

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

Built distribution (wheel)

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

Total release size: 3.2 MB

Release files / crate_docs_theme-0.51.1.tar.gz

Download URL crate_docs_theme-0.51.1.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
dd31985b3df113dc17ef2a628302b8d9ef9f65808b29672f64fdcf1aae85d35d
BLAKE2b-256 checksum
How to use checksums
87b867403105350087b0a25a0508b9edd25d59996029f3441ffbf81d5515df66
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.1-py3-none-any.whl

Download URL crate_docs_theme-0.51.1-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
87b93dd8028aef2996eb580e21c77e0b51a383e7c6c822d33ab13056c2548e4d
BLAKE2b-256 checksum
How to use checksums
dec35a598c29d1adf8d20176821b4ee56c15765c0e057179e6155123b2683937
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.1

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.1 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