Sphinx 基础

Note

reStructuredText（reST）是Docutils和Sphinx使用的默认纯文本标记语言。Docutils提供了基本的reStructuredText语法，而Sphinx扩展了它以支持其他功能。

本章主要介绍了reST语法中最常用的部分，更多细节内容，可以参考Sphinx源站:

• [1] RestructureText Index
• [2] reStructuredText Primer
• [3] reStructuredText Directives
• [4] Sphinx 主题

Table of Contents

• 1. Sphinx 安装和使用
  • 1.1. 概述
  • 1.2. 基本介绍
  • 1.3. 安装
  • 1.4. 项目构建
  • 1.5. 调试部分
  • 1.6. 参考
• 2. Admonitions
  • 2.1. admonition
  • 2.2. caution
  • 2.3. danger
  • 2.4. error
  • 2.5. hint
  • 2.6. important
  • 2.7. note
  • 2.8. tip
  • 2.9. warning
• RestructureText Index

---

[1]	RestructureText Index: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

[2]	RestructureText Primer： http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

[3]	RestructureText Directives： http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

[4]	Sphinx 主题： https://sphinx-themes.org/