Welcome to A Brief Tutorial On Making Beauty Documents!

• 邮箱（email）：zhiliu.mind@gmail.com

• 博客（blog）：http://blog.csdn.net/enjoyyl

• 主页（homepage）：http://iridescent.ink

Hint

PDF 版文档可以点这里查看

写于2015年6月24日

---

• 1. 引言
  • 1.1. 手册自述
    • 1.1.1. 目标
    • 1.1.2. 撰写与发布
• 2. 基础教程
  • 2.1. 文档制作简介
    • 2.1.1. 标记语言简介
      • 2.1.1.1. Markdown标记语言
      • 2.1.1.2. reStructuredText标记语言
      • 2.1.1.3. 标记语言的优点
    • 2.1.2. 使用标记语言需要会什么？
  • 2.2. Sphinx简明教程
    • 2.2.1. What is Sphinx
    • 2.2.2. Why Sphinx
    • 2.2.3. 安装Sphinx
      • 2.2.3.1. 依赖
      • 2.2.3.2. Linux系统
      • 2.2.3.3. Windows系统
    • 2.2.4. 使用Sphinx
      • 2.2.4.1. 手册文档
      • 2.2.4.2. 一起动起来吧
        • 2.2.4.2.1. 配置文档资源
        • 2.2.4.2.2. 构建文档
        • 2.2.4.2.3. 自动构建并预览文件
        • 2.2.4.2.4. 撰写文档
    • 2.2.5. 使用主题
      • 2.2.5.1. Sphinx自带主题
        • 2.2.5.1.1. 更改内置主题
        • 2.2.5.1.2. 使用readthedocs主题
    • 2.2.6. 生成不同格式的文档
      • 2.2.6.1. 生成html静态网站文件
      • 2.2.6.2. 生成epub文档
      • 2.2.6.3. 生成LaTex文档
      • 2.2.6.4. 生成PDF文档
    • 2.2.7. 问题集锦
      • 2.2.7.1. 源编码
      • 2.2.7.2. 中文文档问题
      • 2.2.7.3. 中文分词问题
      • 2.2.7.4. 中文乱码问题
      • 2.2.7.5. Sphinx数学支持
        • 2.2.7.5.1. 使用LaTex渲染公式
        • 2.2.7.5.2. 使用KaTex渲染公式
        • 2.2.7.5.3. 使用MathJax渲染公式
    • 2.2.8. 发布静态网站
      • 2.2.8.1. 使用Apache建立自己的网站服务器
        • 2.2.8.1.1. 安装apache2
        • 2.2.8.1.2. 配置apache2
    • 2.2.9. 使用Git版本控制系统
  • 2.3. reStructuredText简明教程
    • 2.3.1. What is reStructuredText
    • 2.3.2. Why reStructuredText
    • 2.3.3. reST环境搭建
      • 2.3.3.1. Sublime Text及其安装
        • 2.3.3.1.1. Sublime Text的安装
        • 2.3.3.1.2. ST中插件包的安装
        • 2.3.3.1.3. 配置reST环境
    • 2.3.4. reST语法简介
      • 2.3.4.1. 章节 (Section Structure)
      • 2.3.4.2. 段落 (Paragraphs)
      • 2.3.4.3. 行内标记 (Inline Markup)
      • 2.3.4.4. 列表 (Lists)
      • 2.3.4.5. 源代码 (Source Code)
      • 2.3.4.6. 侧边栏 (Sidebar)
      • 2.3.4.7. 表格 (Tables)
      • 2.3.4.8. 直接标记 (Explicit Markup)
      • 2.3.4.9. 指令 (Directives)
        • 2.3.4.9.1. 数学
        • 2.3.4.9.2. 图像
        • 2.3.4.9.3. 提示警告类
        • 2.3.4.9.4. 主题
        • 2.3.4.9.5. 额外的主体元素
        • 2.3.4.9.6. 专用表格
        • 2.3.4.9.7. 专用指令
        • 2.3.4.9.8. HTML 特性
      • 2.3.4.10. 超链接 (Hyperlinks)
        • 2.3.4.10.1. 外部链接
        • 2.3.4.10.2. 内部链接
      • 2.3.4.11. 脚注 (Footnotes)
      • 2.3.4.12. 引文 (Citations)
      • 2.3.4.13. 替换 (Substitutions)
      • 2.3.4.14. Sphinx扩展指令
  • 2.4. Sphinx重要扩展介绍
    • 2.4.1. Sphinx内置扩展
      • 2.4.1.1. 重要内置扩展介绍
        • 2.4.1.1.1. 目录树 (toctree)
        • 2.4.1.1.2. 代码与语法着色
        • 2.4.1.1.3. 公式, 图, 表, 代码段编号及引用
      • 2.4.1.2. 其它标记指令
        • 2.4.1.2.1. More domains
    • 2.4.2. 第三方扩展
      • 2.4.2.1. 第三方扩展简介及安装
      • 2.4.2.2. 推荐使用的第三方扩展
        • 2.4.2.2.1. sphinxcontrib-proof
        • 2.4.2.2.2. 图表编号
        • 2.4.2.2.3. sphinxcontrib-bibtex
        • 2.4.2.2.4. sphinxcontrib-xxxdiag
  • 2.5. Sphinx其它语言支持
    • 2.5.1. 简介
  • 2.6. 版本控制系统Git教程
    • 2.6.1. What is Git?
    • 2.6.2. Why Git?
    • 2.6.3. How to
      • 2.6.3.1. 安装Git
        • 2.6.3.1.1. Windows
        • 2.6.3.1.2. Linux
      • 2.6.3.2. 创建本地仓库
      • 2.6.3.3. 版本库管理
        • 2.6.3.3.1. 瘦身
      • 2.6.3.4. 远程仓库
      • 2.6.3.5. 分支管理
      • 2.6.3.6. 标签话管理
    • 2.6.4. Git命令概览
      • 2.6.4.1. 自定义快捷命令
    • 2.6.5. 子模块
      • 2.6.5.1. 自动下载
    • 2.6.6. 搭建Git服务器
      • 2.6.6.1. 参考示例
      • 2.6.6.2. 安装配置SSH服务端客户端
      • 2.6.6.3. 安装配置Git服务端客户端
        • 2.6.6.3.1. Git服务端配置
        • 2.6.6.3.2. Git客户端配置
    • 2.6.7. 简化命令
      • 2.6.7.1. 自定义域名
      • 2.6.7.2. 克隆
    • 2.6.8. 错误解决
      • 2.6.8.1. Clone过程
      • 2.6.8.2. SSH秘钥
  • 2.7. 参考文献
• 3. 进阶指南
  • 3.1. 简介
  • 3.2. API手册制作指南
    • 3.2.1. 一个例子
      • 3.2.1.1. 撰写代码和文档
      • 3.2.1.2. 初始化Sphinx工程
      • 3.2.1.3. 配置Sphinx工程
      • 3.2.1.4. 生成API注释文档
      • 3.2.1.5. 编译生成API手册
    • 3.2.2. 文档注释风格支持
    • 3.2.3. 问题解决
      • 3.2.3.1. 生成的文档无注释
      • 3.2.3.2. 注释中不显示公式
  • 3.3. 项目文档制作指南
  • 3.4. 发布网站到GitHub
    • 3.4.1. 什么是 GitHub Pages
    • 3.4.2. 为你的工程库制作网站
• 4. 名词术语

Indices and tables

• Index

• Search Page