如何解决添加使用Sphinx在运行时生成的属性的文档
我的类实现了一个__getattr__
方法,对于有限数量的可接受键,该方法返回有效数据。我想在类内为这几个键添加docstring文档,以便它们按标准属性(标有@property
装饰器)的形式列出,即在“属性摘要”部分和生成的HTML输出的“属性文档”部分中的完整文档。
有可能吗?我尝试使用“属性”关键字,但是生成的文档与其余文档分开。
可视化我的问题的简短示例:
class Example(object):
"""Some documentation of the class
Attributes
----------
bb
Documentation of "bb"
"""
@property
def aa(self):
"""Documentation of "aa" """
pass
def __getattr__(self,key):
if key == "bb": # valid key emulating a property
pass
生成的文档如下所示:
谢谢!
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。