CrateDB Docs Theme
A Sphinx theme for the CrateDB documentation.
Prerequisites
You will need Python 2.7.
Installation
The CrateDB docs theme is available as a pip package.
To install, run:
$ pip install crate-docs-theme
To update, run:
$ pip install -U crate-docs-theme
Configuration
The CrateDB reference site is composed of multiple documentation bases, seemlessly interlinked via the CrateDB docs theme navigation. The CrateDB docs theme includes one configuration module per project that can be listed in the navigation.
In your Sphinx conf.py, import all of these modules like so:
from crate.theme.rtd.conf import *
Or, if you only want to use a specific module, do this:
from crate.theme.rtd.conf.crate_server import *
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 StackOverflow for common problems
- Chat with us on Slack
- Get paid support