Получить Sphinx для автодокумента __init__ моего класса Cython - PullRequest
0 голосов
/ 29 января 2012

У меня есть этот класс Cython:

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

И я хочу, чтобы Сфинкс задокументировал это так:

класс Спрайт ( Я, текстура )
Делает вещи.

поэтому я попытался задокументировать это:

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

На этот раз он появился, но Сфинкс не делал магические вещи с этой информацией, как обычно:

класс спрайт
Спрайт (Я, текстура)

Делает вещи.

Так как мне это сделать?

1 Ответ

1 голос
/ 29 января 2012

Оказалось, что это ошибка, я добавил отчет об ошибке и исправление здесь:

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

...