1. 新建文件夹sphinxDemo

2. 命令行在路径/sphinxDemo下执行sphinx-quickstart

sphinx简单使用

3. 修改source/conf.py

sphinx简单使用
修改为
sphinx简单使用
AND

sphinx简单使用
修改为
sphinx简单使用

4. 在 sphinxDemo下创建文件夹src 并将源代码文件放入

5. 命令行在路径sphinxDemo下执行 sphinx-apidoc -o source src

6. 命令行在路径sphinxDemo下执行 make html

7. 文件路径sphinxDemo\build\html下找到Index.html打开

sphinx简单使用

①打开之后:

sphinx简单使用

②点击"索引":

sphinx简单使用

③点击一个函数:

sphinx简单使用

相关文章: