Read the Docs Sphinx Theme

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is commonly used with projects on Read the Docs but can work with any Sphinx project.

使用此主题

安装

如何在您的 Sphinx 项目上安装此主题。

配置

主题配置和自定义选项。

支持的浏览器

支持的浏览器/操作系统组合。

支持的依赖项

支持项目依赖项,如 Python 和 Sphinx。

发展

贡献

如何对主题做出改变。

Development guidelines

主题开发人员用于开发和测试更改的指南。

Read the Docs contributor guide

我们的贡献指南适用于由 Read the Docs 核心团队维护的所有项目。

变更日志

主题开发更新日志。

Demo documentation

主题的样式指南测试环境,在此测试新的变化。