如何记录Flask网页应用
我需要为我用Python和Flask框架开发的一个网页应用写文档。这份文档会包含这个应用对每种可能使用它的角色所提供的不同功能。
我在考虑在应用里加一个维基引擎，因为我需要一个简单的方法来随着应用的发展不断更新文档。有什么更自然的方法来实现这个需求呢？
2 个回答
1
你可以试试 Sphinx，网址是 http://sphinx-doc.org。
我在几个项目中用过它，不过我更喜欢把这种文档和代码分开来写。
2
你有很多方法可以做到这一点：
Sphinx (http://sphinx-doc.org/): 我觉得这是最常用的Python文档工具。
PyDoc (http://docs.python.org/library/pydoc.html): 这是一个老牌的、内置的文档生成器。
你提到的是web应用，所以如果你的应用包含rest API，我建议你使用：
Flask-swagger (https://github.com/rantav/flask-restful-swagger): 这个工具可以生成部分文档，并让你自己定义其余的内容。
apiDoc (http://apidocjs.com/): 这个工具让你可以在注释中定义API的所有部分。你还可以自定义模板等等。