crate-docs-theme 0.49.1

CrateDB Documentation Theme

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?

• Check out our support channels