Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/321.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python sphinx apidoc能否包含超类方法的显式文档?_Python_Inheritance_Python Sphinx - Fatal编程技术网

Python sphinx apidoc能否包含超类方法的显式文档?

Python sphinx apidoc能否包含超类方法的显式文档?,python,inheritance,python-sphinx,Python,Inheritance,Python Sphinx,我正在考虑使用Sphinx来记录Python项目。我希望类的api文档包含可以从类调用的所有方法的文档。默认行为似乎是提供指向超类的链接。因此,要查看所有可调用的方法,我必须在继承树中单击后退。我看到的javadoc或doxygen生成的文档至少显示了可以调用的所有方法的名称 在sphinx中是否可以显示本地方法的文档,以及至少在超类中定义的方法的名称?对我来说,这是可取的。我想要的不是一个好主意,有什么原因吗?斯芬克斯内部是否有其他方法 B计划是探索Pydoctor。对C、D等计划有什么建议吗

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

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


B计划是探索Pydoctor。对C、D等计划有什么建议吗

你调查过这件事了吗?特别是,请参见:inherited members:。@jornsharpe是的,我确实看到了:inherited members:,并实现了它。它没有产生预期的效果,尽管我预料到了。我不确定它是否有任何效果。但如果您告诉我它应该可以工作,那么我将更仔细地查看sphinx文件conf.py等,以确保它们的结构正确。这对我来说是新的,所以我根本不确定一切都是正确的。@jonrsharpe事实上,inherited members选项提供了指向我在OP中提到的超类文档的链接。它没有提到可以从子类调用的超类方法。