69、Sphinx 文档生成器：高效创建项目文档的利器

Sphinx 文档生成器：高效创建项目文档的利器

1. reStructuredText 简介

reStructuredText 是一种简单且功能广泛的语言，在编写纯文本笔记时，大部分语法使用起来很自然。例如，最简单的块引用只需简单缩进即可：

Normal text
    Quoted text

2. Sphinx 文档生成器概述

Sphinx 文档生成器于 2008 年为 Python 2.6 版本发布而创建，用于取代旧的 Python LaTeX 文档。它不仅能轻松为编程项目生成文档，在非编程领域也能方便使用。
- 支持的编程语言 ：Python、C、C++、Javascript、reStructuredText 等，还为许多其他语言提供扩展，如 CoffeeScript、MATLAB、PHP、Ruby Lisp、Go 和 Scala。
- 代码高亮 ：内部使用的 Pygments 高亮器支持超过 120 种语言，且可按需轻松扩展新语言。
- 重要优势 ：几乎所有文档都能从源代码自动生成，确保文档始终保持最新。

3. 开始使用 Sphinx

3.1 安装 Sphinx

使用 pip 进行安装：

pip install sphinx

3.2 启