MIO米欧

Sphinx：一种文档生成工具

今天看到symfony中文网，有一个反复看到的单词：

Sphinx —— 文档基于Sphinx，使用的标注格式是reST，并托管在ReadTheDocs.org。

决定了解一下：

简介：

Sphinx[1]  是一个工具，它能够轻易地创建智慧和优雅的文档，出自Georg Brandl之手，在BSD许可证下授权。它能够把一组 reStructuredText 格式的文件转换成各种输出格式，而且自动地生成交叉引用，生成目录等。也就是说，如果有一个目录，里面包含一堆reST格式的文档（可能子目录里面也同样存在reST格式的文档），Sphinx能够生成一个漂亮的组织结构以及便于浏览和导航的HTML 文件（这些文件在其他的文件夹中）。当然对于同样的来源文件（reST格式），它也能够生成一个能够被编译（生成）PDF版本的LaTeX格式的文件[2]  。

特性：

• 多种输出格式： 超文本标记语言 (包括Windows HTML帮助)，LaTeX (可打印的PDF版本)，手册页，纯文本

• 丰富的交叉引用： 语义标记以及针对函数，类，引用，词汇表（术语）和相似的信息块的自动链接

• 层次结构： 简单的文本树定义，就能自动地链接到同层（兄弟姐妹）、上一层（父母）以及下一层（子女）的文本位置

• 自动生成目录： 通用索引以及语言模块的目录

• 代码高亮： 代码自动高亮，通过使用 Pygments

• 扩展功能： 自动测试的代码片段，包括从Python模块（API文档）的文档字符串

----------------------------------

官网：https://www.sphinx-doc.org/en/stable/

中文网：https://www.pythondoc.com/sphinx/index.html