Skip to main content

Crate Docs Theme

Project description

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


A Sphinx theme for the Crate documentation.

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

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


The demo/preview project is rendered and published to

Using the theme


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


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


The documentation is composed of multiple separate documentation projects, seamlessly interlinked via the Crate docs theme.

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

from import *

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


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

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


Looking for more help?

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crate_docs_theme-0.33.1.tar.gz (2.1 MB view hashes)

Uploaded Source

Built Distribution

crate_docs_theme-0.33.1-py3-none-any.whl (2.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page