如何解决如何为 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 举报,一经查实,本站将立刻删除。