跳转到主要内容

Crate文档主题

项目描述

CI status Read the Docs status crate-docs version PyPI version

关于

这是一个针对SphinxCrate文档的主题。

注意:此主题与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维护,但我们欢迎社区贡献!

有关更多信息,请参阅开发者文档贡献文档

帮助

需要更多帮助?

项目详情


发行历史 发布通知 | RSS源

下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

crate_docs_theme-0.34.1.tar.gz (1.6 MB 查看哈希值)

上传时间

构建分布

crate_docs_theme-0.34.1-py3-none-any.whl (1.6 MB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面