构建你的第一个项目

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

本教程面向有意愿学习Sphinx基础知识的新手，学习一个项目是如何创建和组织的。您将创建一个虚构的、生成随机食谱的软件库，作为贯穿整个过程的指南，目的是对其进行适当的文档编制

为了展示 Sphinx 在代码文档编制方面的能力，您将使用 Python，其也支持 自动 (代码)文档生成。（译者注： “代码文档” 指的是从代码文件的注释里提取信息、生成的文档）

备注

Sphinx 原生支持多种其他语言的 手动 代码文档编制，但它们需要扩展来实现 自动 代码文档编制，例如 Breathe。

为了跟着说明操作，您需要访问类似 Linux 的命令行并对其工作原理有基本了解，以及一个有效的 Python 开发环境，因为您将使用 Python 虚拟环境 来创建项目。