Sphinx 学习笔记

• Sphinx 安装
• Sphinx 的简单使用
  • 1. 快速构建文档
  • 2. 进行一些项目设置
  • 3. 写作
  • 4. 生成 html
• Sphinx 使用 LaTeX 引擎渲染数学公式
  • 添加插件
  • 行间公式
  • 行内公式
  • 示例
• Sphinx 常见问题及解决方式
  • 部分常用的 reStructuredText 标记
  • 如何固定主题 alabaster 的侧边栏
  • 如何取消主页的 Page source 链接
  • 如何个性化网页图标(设置 favicon)
  • reStructuredText sublime text 的三款辅助插件
  • 补全插件 Restructured Text (RST) Snippets
  • 如何使用原始的 html 标签
  • 如何支持中文搜索
  • Sphinx 生成 PDF
• Sphinx make 命令
• Sphinx 语法高亮支持的关键字
• Sphinx 部署