教程：构建您的第一个项目

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

本教程面向愿意学习如何创建和构建项目的基础知识的Sphinx新手。您将创建一个虚构的软件库来生成随机的食物食谱，该食谱将在整个过程中作为指南，目标是正确地记录下来。

要展示Sphinx的代码文档功能，您将使用Python，它还支持 automatic 文档生成。

备注

Sphinx本身支持几种其他语言，用于 manual 代码文档，但是它们需要扩展 automatic 代码文档，如 Breathe 。

要按照说明操作，您需要访问类似于Linux的命令行，基本了解其工作原理，以及用于开发的可运行的Python安装，因为您将使用 Python virtual environments 以创建该项目。