sphinx and reStructureText handbook

用于学习sphinx和reStructureText

Contents:

• 1. sphinx介绍
  • 1.1. 基本介绍
  • 1.2. 安装
  • 1.3. 与其他标记语言互相转换
  • 1.4. 快速开始
• 2. sphinx配置
  • 2.1. 项目信息
  • 2.2. 一般配置项
  • 2.3. 国际化选项
  • 2.4. 数学选项
  • 2.5. HTML输出选项
  • 2.6. EPUB输出配置项
  • 2.7. LaTeX输出配置项
  • 2.8. 文本输出选项
  • 2.9. HTML主题
  • 2.10. Markdown支持
  • 2.11. HTML模板
  • 2.12. sphinx扩展ext
  • 2.13. 配置文件示例
• 3. reStructureText语法
  • 3.1. 内联标记 Inline Markup
  • 3.2. 反斜杠转义 Escaping with Backslashes
  • 3.3. 章节标记 Section Structure
  • 3.4. 段落 Paragraphs
  • 3.5. 无序列表 Bullet Lists
  • 3.6. 有序列表 Enumerated Lists
  • 3.7. 定义列表Definition Lists
  • 3.8. 字段列表 Field Lists
  • 3.9. 参数(选项)列表 Option Lists
  • 3.10. 文字块 Literal Blocks
  • 3.11. 行块 Line Blocks
  • 3.12. 块引用 Block Quotes
  • 3.13. 文档测试块 Doctest Blocks
  • 3.14. 表格 Tables
  • 3.15. Transitions
  • 3.16. 脚注 Footnotes
  • 3.17. 引用Citations
  • 3.18. 超链接Hyperlink Targets
  • 3.19. 扩展指令 Directives
  • 3.20. Substitution References and Definitions
  • 3.21. Comments
• 4. Reference
  • 4.1. 编辑工具
  • 4.2. 参考内容
• 5. Pygments

Indices and tables

• 索引
• 模块索引
• 搜索页面