Sphinx快速入门指南

本章文档介绍Sphinx的安装及主要语法。 <<<<<<< HEAD 本章文档介绍Sphinx的安装及主要语法。 ======= this is a new merge. >>>>>>> fz01

Sphinx文档方案

• 1. Sphinx and RST
  • 1.1. Sphinx简介
  • 1.2. rst简介
• 2. Sphinx安装
  • 2.1. 安装Python
  • 2.2. 安装Sphinx
• 3. 创建Sphinx工程
  • 3.1. 创建文档工程
  • 3.2. 设置主题
  • 3.3. 生成文档
  • 3.4. 预览文档

基础语法

• 1. 标题学习
  • 1.1. 二级标题是这样的
    • 1.1.1. 三级标题是这样的
      • 1.1.1.1. 四级标题是这样的
        • 1.1.1.1.1. 五级标题
          • 1.1.1.1.1.1. 六级标题
• 2. 段落学习
• 3. 列表学习
  • 3.1. 圆点列表
  • 3.2. 顺序列表
  • 3.3. 定义列表
  • 3.4. 字段列表
  • 3.5. 选项列表
• 4. 块学习
  • 4.1. 文字块
  • 4.2. 行块
  • 4.3. 块引用
  • 4.4. 文档测试块

中级语法

• 1. 表格学习
  • 1.1. 格网表格
  • 1.2. 简单表
• 2. 水平线学习
• 3. 显式标记
• 4. 引用
• 5. 超链接
• 6. 图片
• 7. 替换引用和定义
• 8. 注释
• 9. 代码块
  • 9.1. bash代码样例
  • 9.2. python代码样例
  • 9.3. json对象样例展示
• 10. 强调

Sphinx标记结构

• 1. toctree
• 2. 内联标记
  • 2.1. ref
  • 2.2. doc
  • 2.3. download
  • 2.4. 替换
• 3. 段落级别标记
• 4. 表内容标记
• 5. 显示代码
  • 5.1. 使用codeblock
  • 5.2. 显示行号
  • 5.3. 突出特定行
  • 5.4. 引用一个文件
  • 5.5. diff2个文件
• 6. 其他标记
  • 6.1. 字段标记
  • 6.2. csv表格
  • 6.3. csv表格引用一个csv文件的
  • 6.4. listtable表格