Crate文档主题
项目描述
关于
注意:此主题与Crate.io网站紧密集成,并不适用于通用用途。
要修改主题,请参阅开发者文档。
预览
演示/预览项目已渲染并发布到https://crate-docs-theme.readthedocs.io/。
使用主题
先决条件
文档可以包含UML图,这些图将使用sphinxcontrib-plantuml渲染。为了满足其要求,请运行
# On Linux apt-get install plantuml # On macOS brew install plantuml
安装
Crate文档主题作为PyPI上的一个包提供。但是,您无需自行安装它。使用该主题的Crate项目应自动安装。
配置
Crate.io文档由多个独立的文档项目组成,通过Crate文档主题无缝连接。
要使用主题,将以下行添加到您的Sphinx conf.py文件中
from crate.theme.rtd.conf.foo import *
在此,将foo替换为您的文档项目的适当模块。
贡献
该项目主要由Crate.io维护,但我们欢迎社区贡献!
帮助
需要更多帮助?
查看我们的支持渠道