添加使用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 (将#修改为@）