在Python中,当使用Sphinx文档生成工具生成文档时,内部类中的属性默认不会显示来自父类的属性的docstring。这是因为Sphinx默认只会显示当前类的属性和方法的文档信息。
如果想要在内部类中显示来自父类的属性的docstring,可以使用Sphinx提供的特殊注释.. autoattribute::
来实现。以下是具体的步骤:
conf.py
文件,找到autodoc_default_options
配置项,并确保其中包含了inherited-members
选项。这样才能让Sphinx自动识别并显示继承自父类的成员。autodoc_default_options = {
'inherited-members': True,
}
.. autoattribute::
注释来显示来自父类的属性的文档信息。将父类的属性名作为参数传递给.. autoattribute::
注释。class MyClass:
"""
This is the docstring of MyClass.
"""
class InnerClass(ParentClass):
"""
This is the docstring of InnerClass.
.. autoattribute:: ParentClass.parent_attribute
"""
通过以上步骤,再使用Sphinx生成文档时,就能够显示内部类中来自父类的属性的docstring了。
请注意,以上方法适用于Sphinx生成的文档,具体的实现方式可能会因使用的Sphinx版本或配置而有所差异。另外,本回答中没有提及具体的腾讯云相关产品和产品链接地址,如有需要,请自行参考腾讯云文档或咨询腾讯云官方支持。
领取专属 10元无门槛券
手把手带您无忧上云