如何记录烧瓶webapp

Question

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

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

Answer 1

您可以尝试Sphinx http://sphinx-doc.org。

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

Answer 2

你有很多方法可以做到：

Sphinx （http://sphinx-doc.org/）：我认为最常用的python工具。

PyDoc （http://docs.python.org/library/pydoc.html）：旧的但原生的doc生成器。

您谈论的是webapp，因此如果您的应用包含 rest API，我建议您使用：

Flask-swagger （https://github.com/rantav/flask-restful-swagger）：它会生成部分文档，让您定义其余部分

apiDoc （http://apidocjs.com/）：让您在评论中定义api的所有部分。您可以自定义模板等。