Crate Docs Theme
Project description
About
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 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 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?
Check out our support channels
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
Built Distribution
Hashes for crate_docs_theme-0.36.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 13ccd814a4fe96c7af2c8a0bb54251217be58159874cecf035acaabb0c247479 |
|
| MD5 | df15cd5cc828b53fb5e5d03a599299c4 |
|
| BLAKE2b-256 | e7b769019283561b40c8b60d259390e1d4225b1356520724b4a58ed520aaa3dc |
