python 文档自动生成_Python 自动生成项目文档

做项目毕竟还是要和别人交流的，一应要有一个好的规范，最好是在做项目之前就达成共识，免得项目进行到一半才发现每个人代码风格千差万别，文档乱八七糟，难以阅读。

最近做的一个项目，简直有点深似海的感觉。项目由很多人共同完成，由我来整合大家写的模块。项目的推进是边摸索边进行，期间还有人跑路，很是头疼。因此越发的认识到写好一个文档有多么重要。

一方面是逻辑文档，介绍每个单独模块的逻辑功能，另一方面就是代码文档，方便别人理解自己的代码。今天发现了一个Python的库Python-Sphinx，用于自动生成项目文档，还不错，记录一下。

准备个小工程

先上代码吧，建立一个小工程project_test，两个代码test1.py,test2.py。

# -*- coding: utf-8 -*-

"""

Spyder Editor

this is just a test!

"""

class Test1():

'''

测试类，负责测试

'''

def hello(self):

'''

打印Hello

:return:

'''

print("Python")

def renren(self):

'''

测试Sphinx自动生成文档

:return:

'''

print("自动生成文档")

class Test2():

def test_2(self):

'''

hello

:return:

'''