时间戳

首页 > 解决方案 > 如何为 Python 数据类编写 Sphinx 文档？

python - 如何为 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

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

标签： pythonpython-sphinxpython-dataclassescode-documentation

解决方案

推荐阅读