Sphinx入门

本文源码: https://github.com/azuwis/sphinx_demo

目录:

• 1. 安装
  • 1.1. 安装Sphinx
  • 1.2. Sphinx版本
  • 1.3. 安装Livereload浏览器插件
  • 1.4. 选择合适的编辑器
• 2. 使用
  • 2.1. 构建Sphinx工程
  • 2.2. 如何使用模板
  • 2.3. 使用Livereload
  • 2.4. 生成PDF
  • 2.5. 注意事项
  • 2.6. 常用链接
• 3. 样例
  • 3.1. 标题
  • 3.2. 段落
  • 3.3. 文字强调
  • 3.4. 图片
  • 3.5. 链接
  • 3.6. 引用
  • 3.7. 脚注(Footnote)
  • 3.8. 代码段
  • 3.9. 列表
  • 3.10. 表格
  • 3.11. 字段列表(Field lists)
  • 3.12. 边栏(Sidebar)
  • 3.13. 箴言(Admonitions)
  • 3.14. 替代(Substitution)
  • 3.15. 内嵌HTML
  • 3.16. 自动生成目录
  • 3.17. 锚点跳转
  • 3.18. CSS样式
• 4. reStructuredText 入门
  • 4.1. 段落 Paragraphs
  • 4.2. 行内标记 Inline markup
  • 4.3. 列表和引用块 Lists and Quote-like blocks
  • 4.4. 源代码 Source Code
  • 4.5. 表格 Tables
  • 4.6. 超链接 Hyperlinks
  • 4.7. 章节 Sections
  • 4.8. 直解标记 Explicit Markup
  • 4.9. 指令 Directives
  • 4.10. 图片 Images
  • 4.11. 脚注 Footnotes
  • 4.12. 引证 Citations
  • 4.13. 替换 Substitutions
  • 4.14. 注释 Comments
  • 4.15. 源文本编码 Source encoding
  • 4.16. 嗯嗯嗯 Gotchas
• 5. A ReStructuredText Primer
  • 5.1. Structure
  • 5.2. Text styles
  • 5.3. Lists
  • 5.4. Preformatting (code samples)
  • 5.5. Sections
  • 5.6. Images
  • 5.7. What Next?
• 6. Quick reStructuredText
• 7. The reStructuredText Cheat Sheet: Syntax Reminders
  • 7.1. Section Structure
  • 7.2. Body Elements
  • 7.3. Inline Markup
  • 7.4. Directive Quick Reference
  • 7.5. Interpreted Text Role Quick Reference
• 8. reStructuredText Markup Specification
  • 8.1. Quick Syntax Overview
  • 8.2. Syntax Details
  • 8.3. Error Handling
• 9. reStructuredText Directives
  • 9.1. Admonitions
  • 9.2. Images
  • 9.3. Body Elements
  • 9.4. Tables
  • 9.5. Document Parts
  • 9.6. References
  • 9.7. HTML-Specific
  • 9.8. Directives for Substitution Definitions
  • 9.9. Miscellaneous
  • 9.10. Common Options