教程:构建第一个项目

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

本教程面向愿意学习基础知识的狮身人面像新手项目的创建和结构。你将创造一个虚构的生成随机食物食谱的软件库,作为指南在整个过程中,以正确记录为目标。

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

注释

Sphinx本机支持其他几种语言手册代码文档,但它们需要扩展自动的代码文档,如呼吸.

要按照说明进行操作,您需要访问类似Linux的命令行并基本了解其工作原理,以及Python安装用于开发,因为您将使用Python虚拟环境创建项目。