Sphinx将python代码注释生成文档
来源:互联网 发布:b超数据算胎儿体重 编辑:程序博客网 时间:2024/05/03 14:28
安装
使用pip进行安装:
pip install sphinx
初始化
进入你代码所在的目录,输入:
sphinx-quickstart
下图:PRD是代码所在目录,生成的文档保存目录设成doc
下图:设置项目名称与作者,项目名称之后会作为标题显示在文档首页
下图:基本一路默认
下图:到此,生成doc文件夹
配置修改
进入此文件夹找到conf.py文件,打开编辑,将下面几行代码(第19-21行)取消注释:
import osimport syssys.path.insert(0, os.path.abspath('.'))
并修改代码为:
sys.path.insert(0, os.path.abspath('../..'))
生成 rst
到代码目录,执行以下命令,会生成对应 python 文件名的 rst 文件
sphinx-apidoc -o ./doc ./
生成 html
进入doc文件夹,执行make指令,生成html文档页
0 0
- Sphinx将python代码注释生成文档
- sphinx根据python注释生成文档
- 利用Sphinx轻松生成python代码的文档
- 利用Sphinx轻松生成python代码的文档
- python代码注释文档
- 使用sphinx快速生成Python API 文档
- 使用Sphinx为你的python模块自动生成文档
- 使用Sphinx为你的python模块自动生成文档
- python 文档生成器 sphinx
- 使用GhostDoc为代码生成注释文档
- 使用GhostDoc为代码生成注释文档
- C#代码注释规范及文档生成
- Xcode 自动生成代码注释文档
- python快速生成注释文档的方法
- 将C#文档注释生成.chm帮助文档
- 将python代码和注释分离
- javadoc——将注释生成API文档
- python自动生成易于阅读的html文档——使用Sphinx
- OAuth 2.0 认证的原理与实践
- linux救援模式
- JAVA和JavaScript的区别
- 远程访问EJB
- 多线程之Java
- Sphinx将python代码注释生成文档
- rdd,scala中的占位符“_”
- 从制作《六龙争霸》看如何取舍游戏的各开发环节
- 递归算法深入浅出一:递归理论概述和常见递归算法罗列
- sass入门
- win7操作小经验
- 华为机试在线训练——计算最后一个单词的长度
- codeforce 787A The Monster 两种解法
- 两个链表的第一个公共节点