Python 如何记录Web应用程序

我必须记录我用Python和Flask框架开发的一个webapp。文档将包含应用程序为每个可能使用它的角色提供的不同功能

我想在应用程序中加入一些wiki引擎，因为随着应用程序的发展，我需要一种简单的方法来改进文档。达到这个要求的更自然的方法是什么？

你可以试试斯芬克斯

我已经在几个项目中使用过它，尽管我更喜欢将此类文档与代码分开。

您可以尝试Sphinx

我已经在几个项目中使用过它，尽管我更喜欢将此类文档与代码分开。

您可以尝试Sphinx

我已经在几个项目中使用过它，尽管我更喜欢将此类文档与代码分开。

您可以尝试Sphinx

---

我在几个项目中使用过它，尽管我更喜欢将此类文档与代码分开。

您有很多方法可以做到这一点：

Sphinx（）：我认为是python最常用的工具

PyDoc（）：旧的本地文档生成器

您谈论webapp，因此如果您的应用程序包含restAPI，我建议您使用：

Flask swagger（）：它将生成文档的一部分，并允许您定义其余部分

---

apiDoc（）：允许您在注释中定义api的所有部分。您可以自定义模板等。

您有很多方法可以做到这一点：

Sphinx（）：我认为是python最常用的工具

PyDoc（）：旧的本地文档生成器

您谈论webapp，因此如果您的应用程序包含restAPI，我建议您使用：

Flask swagger（）：它将生成文档的一部分，并允许您定义其余部分

---

apiDoc（）：允许您在注释中定义api的所有部分。您可以自定义模板等。

您有很多方法可以做到这一点：

Sphinx（）：我认为是python最常用的工具

PyDoc（）：旧的本地文档生成器

您谈论webapp，因此如果您的应用程序包含restAPI，我建议您使用：

Flask swagger（）：它将生成文档的一部分，并允许您定义其余部分

---

apiDoc（）：允许您在注释中定义api的所有部分。您可以自定义模板等。

您有很多方法可以做到这一点：

Sphinx（）：我认为是python最常用的工具

PyDoc（）：旧的本地文档生成器

您谈论webapp，因此如果您的应用程序包含restAPI，我建议您使用：

Flask swagger（）：它将生成文档的一部分，并允许您定义其余部分

apiDoc（）：允许您在注释中定义api的所有部分。您可以自定义模板等