Sphinx 教程

在本教程中，你将使用 Sphinx 建立一个简单的文档项目，并在浏览器中以 HTML 形式查看。该项目将包括叙述性的、手写的文档，以及自动生成的 API 文档。

该教程针对的是愿意学习如何创建和构建项目的基本原理的 Sphinx 新人。你将创建一个虚构的软件库来生成随机的食物食谱，它将作为整个过程的指南，目的是正确记录它。

为了展示 Sphinx 在代码文档方面的能力，你将使用 Python，它也支持 自动 文档生成。

备注

其他几种语言在 Sphinx 中原生支持 手动 代码文档，然而它们需要扩展到 自动 代码文档，比如 Breathe。

遵循说明，需要访问类似于 Linux 的命令行，并对其工作原理有基本的了解，还要有一个用于开发的工作的 Python 安装，因为你将使用 Python 虚拟环境 来创建项目。