构建你的第一个项目

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

本教程面向希望学习项目创建和结构基础知识的 Sphinx 新手。你将创建一个虚构的软件库来生成随机食谱，这将作为整个过程的指南，目标是正确地记录它。

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

注意

Sphinx 原生支持多种其他语言进行 *手动* 代码文档编写，但它们需要扩展才能进行 *自动* 代码文档编写，例如 Breathe。

要按照说明操作，你需要访问类似 Linux 的命令行并对其基本操作有一定的了解，以及用于开发的 Python 工作安装，因为你将使用 *Python 虚拟环境* 来创建项目。