python 函数一览-sphinx快速上手

1.安装python
2.安装sphinx: pip install sphinx
3.创建工程,cmd进入doc路径下输入(doc文件夹为手动创建):sphinx-quickstart
根据提示创建工程，如选择默认可直接回车
创建完毕,doc文件夹下生成如下内容
4为了做成函数一览，首先进入doc\source修改配置文件，使其能够将函数和注释导出来
修改conf.py:
1.修改配置：
extensions = [‘sphinx.ext.autodoc’,
‘sphinx.ext.doctest’,
‘sphinx.ext.intersphinx’,
‘sphinx.ext.todo’,
‘sphinx.ext.coverage’,
‘sphinx.ext.mathjax’]
2添加源代码相对路径
import os
import sys
sys.path.insert(0, os.path.abspath(‘…/…/’))

5.生成HTML
1.仍然在doc路径下：输入指令sphinx-apidoc -o source …/
生成rst文件，参数2为源码路径

2.1.仍然在doc路径下：make html
在build/html下生成html报告

6.sphinx需要使用"“” “”“进行注释
def TestFunction(a,b):
“””
参数:
a：加数
b：加数
返回值：
c:结果
“”"
c = a + b
return c