首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >自定义pdoc自动生成python文档

自定义pdoc自动生成python文档
EN

Stack Overflow用户
提问于 2022-01-17 15:49:06
回答 1查看 562关注 0票数 0

通过执行以下命令,我使用pdoc3在每个python类/函数的开头自动从docstring生成文档

pdoc3 --html ambit_stochastics生成的文档可以在统计/index.html上找到

  1. 我是否可以从索引页上的ambit_stochastics中删除ambit_stochastics.helpers,然后在所有的子页面上删除?这似乎是不必要的和冗长的。
  2. 我可以编辑索引页面(访问链接时弹出的页面)以添加一些介绍性文本吗?其他模板怎么样?
EN

回答 1

Stack Overflow用户

发布于 2022-01-18 14:36:47

如果不编辑模板,就不能确定#1点,但是可以通过在ambit_stochastics/__init__.py 就像pdoc一样中包含一个模块文档字符串来处理#2。这十个呈现在主模块页面上,以及标题的TOC:https://pdoc3.github.io/pdoc/doc/pdoc/

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/70744042

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档