sphinxapidoc能为超类方法包含显式文档吗?

2024-05-15 18:04:38 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在考虑用Sphinx来记录Python项目。我希望类的api文档包含所有可以从类中调用的方法的文档。默认行为似乎是提供指向超类的链接。因此,要查看所有可调用的方法,我必须通过继承树单击back。我看到的由javadoc或doxygen生成的文档至少显示了所有可以调用的方法的名称。在

在sphinx中是否可以显示本地方法的文档,以及至少在超类中定义的方法的名称?对我来说这是可取的。我想要的不是一个好主意,有什么原因吗?在狮身人面像里面有其他的方法吗?在

B计划是探索皮多克医生。对C、D……计划有什么建议吗?在


Tags: 项目方法文档名称api定义链接sphinx