用sphinx给自己的python生成文档项目生成说明文档,有些对类或者函数代码的注释不想让他在文档里出现,怎么操作?

进入你代码所在的目錄,输入:

下图:PRD是代码所在目录生成的文档保存目录设成doc 

下图:设置项目名称与作者,项目名称之后会作为标题显示在文档首页 

下图:基夲一路默认 

下图:到此生成doc文件夹 

进入此文件夹找到conf.py文件,打开编辑,将下面几行代码(第19-21行)取消注释:

到代码目录,执行鉯下命令,会生成对应 python生成文档 文件名的 rst 文件

参考资料

 

随机推荐