构建你的第一个项目

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

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

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

注意

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

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