Crate Docs Theme
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
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 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.
This project is primarily maintained by Crate.io, but we welcome community contributions!
Looking for more help?
- Check out our support channels
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size crate_docs_theme-0.15.4-py3-none-any.whl (998.9 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size crate-docs-theme-0.15.4.tar.gz (962.5 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for crate_docs_theme-0.15.4-py3-none-any.whl