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

发布于 2024-12-29 15:13:50 字数 832 浏览 2 评论 0 原文

我有这个 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(自身,纹理)

    做事。

那么我该怎么做呢?

I have this Cython class:

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

And I want Sphinx to document it like this:

class Sprite(self, texture)
    Does stuff.

so I tried documenting it:

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

        Does stuff."""

        pass

But it didn't even show up. I even tried this:

cdef class Sprite:
    """Sprite(self, someargument)

    Does stuff."""

    def __init__(self, someargument):
        pass

This time it did show up, but sphinx didn't do it's magic stuff with this information like it normally does:

class Sprite
    Sprite(self, texture)

    Does stuff.

So how must I do it?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

清引 2025-01-05 15:13:51

事实证明这是一个错误,我在此处添加了错误报告和修复:

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

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文