用以测试和验证配置能够生效的文档
Sphinx 工具和 reST 标记语言
1. 准备
2. reStructureText 语法学习
2.1. 标题学习
2.2. 基础杂糅
2.3. 指令
2.4. 表格
2.5. 表格指令
2.6. 使用文件
2.7. 代码显示
2.8. 角色
2.9. 域
2.10. 推荐文章形式
2.11. 文章类笔记推荐写法
3. Markdown 支持
4. 配置
5. HTML Theme
Markdown 标记语言
1. Markdown 基础语法
2. Markdown 扩展语法
MyST
1. 入门 MyST
2. MyST 语法指南
3. MyST 的扩展语法
4. MyST 与 Sphinx
5. sphinx_book_theme 下的 MyST 扩展语法
Sphinx 扩展工具
响应式 Web 组件的 Sphinx 扩展—— Sphinx Design
1. 网格 —— grid
2. 卡片 —— card
3. 可下拉选项卡 —— dropdown
4. 标签选项卡 —— tab-set
5. Badges, Buttons & Icons
6. 附加功能
7. 样式 css
实时重新加载 Sphinx 文档
RST-to-MyST 转换工具
自动生成的标题锚点工具
.rst
.pdf
repository
open issue
suggest edit
导航
推荐标题分级2
推荐标题分级3
推荐标题分级4
推荐的标题分级
¶
推荐标题分级2
¶
推荐标题分级3
¶
推荐标题分级4
¶
备注
该分级便于编写。多使用单线的标题,但也不推荐使用太多类型符号的标题。三级标题足以应对大多数场景。