Crate Docs Theme

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for amotl from gravatar.com amotl Avatar for Mathias.Fussenegger from gravatar.com Mathias.Fussenegger Avatar for matkuliak from gravatar.com matkuliak Avatar for matriv from gravatar.com matriv Avatar for smu from gravatar.com smu Avatar for walbeh from gravatar.com walbeh

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License 2.0)
  • Author: Crate.IO GmbH
  • Tags crate, docs, sphinx, readthedocs
  • Requires: Python >=3.7
Classifiers
Report project as malware

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 Crate.io website and is not intended for general use.

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

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

Configuration

The Crate.io 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 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?

Supported by

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