快速入门#
先决条件:您应该对 Sphinx 生态系统 有所了解,并且已经在本地计算机上安装了 Sphinx。
安装并激活主题#
首先使用 pip
安装 xyzstyle
:
pip install xyzstyle
然后,在您的 Sphinx 配置文件( conf.py
)中激活主题:
...
html_theme = "xyzstyle"
...
配置 html_theme
将为您的文档激活 xyzstyle
主题。
进阶教程#
特定于 Daobook sphinx_book_theme 主题的组件: 包含 引言和题词,旁注和边注
包含了可用的基本配置选项说明,可以直接使用。
Sphinx 中文教程。
xyzstyle
的父主题是 sphinx-book-theme
主题。
sphinx-book-theme
的父主题是 pydata-sphinx-theme
主题。
用于将 Jupyter 笔记本编译为高质量文档格式的 Sphinx 和 Docutils 扩展。
用于解析 MyST 的 Sphinx 和 Docutils 扩展,MyST 是一种丰富且可扩展的 Markdown 风格,用于编写技术和科学文档。
Sphinx AutoAPI 是用于生成完整 API 文档的 Sphinx 扩展,无需加载、运行或导入正在记录的项目。
设计简洁的 Sphinx 主题,支持互动内容,并具有现代书籍般的外观和感觉。
Daobook sphinx-intl 中文文档
用于翻译 Sphinx 文档的工具。