让 Sphinx 自动记录我的 Cython 类的 __init__
我有这个 Cython 类:
cdef class Sprite:
def __init__(self, someargument):
pass
我希望 Sphinx 像这样记录它:
类 精灵(自身,纹理)
做事。
所以我尝试记录它:
cdef class Sprite:
def __init__(self, someargument):
"""__init__(self, someargument)
Does stuff."""
pass
但它甚至没有出现。我什至尝试过这个:
cdef class Sprite:
"""Sprite(self, someargument)
Does stuff."""
def __init__(self, someargument):
pass
这次它确实出现了,但是狮身人面像并没有像通常那样用这些信息做神奇的事情:
类 精灵
Sprite(自身,纹理)
做事。
那么我该怎么做呢?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
事实证明这是一个错误,我在此处添加了错误报告和修复:
https://bitbucket.org/birkenfeld/sphinx/issue/866/sphinx-doesnt-check-an-init-docstring#comment-1012906
It turned out to be a bug, I added a bug report and a fix here:
https://bitbucket.org/birkenfeld/sphinx/issue/866/sphinx-doesnt-check-an-init-docstring#comment-1012906