让 Sphinx 自动记录我的 Cython 类的 __init__答案

【问题标题】：Get Sphinx to autodoc my Cython class's __init__让 Sphinx 自动记录我的 Cython 类的 __init__
【发布时间】：2012-01-29 15:36:10
【问题描述】：

我有这个 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

这一次它确实出现了，但 sphinx 并没有像往常那样用这些信息做神奇的事情：

类精灵
精灵（自身、纹理）

做事。

那我该怎么做呢？

【问题讨论】：

可能您的问题与文档字符串支持不足有关：docs.cython.org/src/reference/…
@mzjn: 假，import pygrafix; pygrafix.sprite.Sprite.__doc__ 给了我"Sprite(self, texture)\n\nblablabla"。
ReST 源是什么样的？ pygrafix.sprite.Sprite.__init__.__doc__给你什么了吗？
@mzjn：显然这是一个狮身人面像的错误。
好的，也许这是一个错误。但是，与其指的是 Sphinx 的“神奇东西”，你不能向我们展示如何重现这个错误吗？特别是，您的 reST 标记是什么样的？

【解决方案1】：

原来是一个错误，我在这里添加了一个错误报告和修复：

【讨论】：