sphinx pdoc 生成API文档

sphinx

install

pip install sphinx sphinx_rtd_theme sphinx-autobuild 
pip install recommonmark sphinx_markdown_tables 

sphinx-quickstart
选 y
Project language [en]: zh_CN

conf.py:

import sys
sys.path.append('..')

extensions = [
	'sphinx.ext.autodoc', # for py modules
	'recommonmark', # for md
	'sphinx_markdown_tables' # for md
]

sys.path.append('..') 将代码所在路径添加进系统路径，相对于conf.py使用相对路径

• sphinx-apidoc -o source/docs 代码所在目录(相对 make.bat 路径)
   把自动生成的rst文件放在 source/docs 目录下

以下是生成的API文档的示例图片

• 模块索引

• 索引
  【例子代码】：给出一个例子代码供您去体验

• 在线浏览 ：https://github.com/JieShenAI/blogs/tree/main/sphinx/API

• 阿里云盘下载： https://www.aliyundrive.com/s/HRgvPfjru81

pdoc

相较于 sphinx ，pdoc则显得简单
pip install pdoc
pdoc 软件包 -o 输出文件夹