如何为 Python 数据类编写 Sphinx 文档？

问题描述

有人可以向我解释或指出有关如何使用 Sphinx 记录 Python 数据类的文档吗？我找不到任何东西。

例如一个简单的数据类：

@dataclass
class Hello:
    name: str
    value: str

我应该如何记录这个，例如

我应该使用参数吗？

@dataclass
class Hello:
    """
    :param name: The name. 
    """
    name: str = "hello"
    value: str

但它似乎没有在 Sphinx 中正确渲染，它再次出现在参数块内部和下方。

这似乎正确呈现：

@dataclass
class Hello:
    """
    """
    name: str = "hello" #: The name.
    value: str

但它不适用于较长的评论。

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）