我最近尝试使用sphinx-apidocfromSphinx来帮助从Python项目的API生成特定于sphinx的restructuredtext。
但是,我得到的结果是:
有人知道我是否可以自定义模板的输出?具体来说,我想:
去掉所有“子模块”、“子包”和“模块内容”标题,以及
让我的sphinx-api
文件中docstring的结果直接显示在包的下面,这样如果我单击包名称,我看到的第一件事就是包文档。目前,这个文档被放在每个包部分的最后一个有点奇怪的“模块内容”标题下。
我认为“子模块”和“子包”标题是多余的,因为包/模块的正常标题是“xxx.yyy package”和“xxx.yyy.zzz module”。
上面这个小例子的结构是
orexplore.components包
orexplore.components.mbg120模块
orexplore.simulators包
orexplore.simulators.test包
orexplore.simulators.test.mbg120模块
orexplore.simulators.mbg120模块
在单击包的地方,我在页面上看到的第一件事就是包文档。
甚至可能只是
或explore.components
或explore.components.mbg120
orexplore.模拟器
orexplore.模拟器.test
orexplore.模拟器.test.mbg120
orexplore.模拟器.mbg120
是否有某种方法可以从视觉上区分包装/模块(颜色?会徽?)而不是冗长的“包”和“模块”。
最佳答案
sphinx apidoc脚本使用apidoc.py模块。我无法提供详细的说明,但为了删除标题或自定义输出,您必须编写自己的模块版本。没有其他“模板”。
请注意,如果API和模块结构稳定,则不需要重复运行sphinx apidoc。您可以将生成的RST文件发布一次,然后将其置于版本控制之下。另请参见https://stackoverflow.com/a/28481785/407651。
关于python - 自定义`sphinx-apidoc`的模板,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/29385564/