构建您的第一个项目¶
在本教程中,您将使用 Sphinx 构建一个简单的文档项目,并在浏览器中以 HTML 格式查看它.该项目将包括叙述性、手写的文档,以及自动生成的 API 文档.
本教程面向愿意学习如何创建和构建项目的 Sphinx 新手.您将创建一个虚构的软件库来生成随机食物食谱,这将作为整个过程的指南,目标是正确地记录它.
为了展示Sphinx在代码文档方面的能力,你将使用Python,它也支持*自动*文档生成.
备注
Sphinx 原生支持几种其他语言用于 手动 代码文档,然而它们需要扩展用于 自动 代码文档,例如 Breathe.
要遵循这些说明,您需要访问类似 Linux 的命令行并对其工作原理有一个基本的了解,以及用于开发的 Python 安装,因为您将使用 Python 虚拟环境 来创建项目.