让Sphinx自动调整我的Cython类的__init__

时间:2012-01-29 15:36:10

标签: cython python-sphinx autodoc

我有这个Cython类:

cdef class Sprite:
    def __init__(self, someargument):
        pass

我希望Sphinx像这样记录下来:

  

class Sprite self,texture
  做的东西。

所以我尝试记录它:

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

这一次它确实出现了,但是狮身人面像并没有像通常那样对这些信息做出神奇的事情:

  

class 精灵
  精灵(自我,纹理)

  做的东西。

那我该怎么做呢?

1 个答案:

答案 0 :(得分:1)

事实证明这是一个错误,我在这里添加了错误报告和解决方法:

https://bitbucket.org/birkenfeld/sphinx/issue/866/sphinx-doesnt-check-an-init-docstring#comment-1012906