sphinx naming special-members

Question

Это мой первый раз, когда я использовал Sphinx, и до сих пор я многое выяснил, но есть одно особое предупреждение. Я получаю, что не могу понять, что он мне говорит.

Согласно документации по http://www.sphinx-doc.org/en/stable/ext/autodoc.html, Python «особых» элементов (то есть те, названные как специального) будет включена, если опция флага специальных членов-Дана:

.. autoclass:: my.Class 
    :members: 
    :private-members: 
    :special-members: 

бы документ как «частные», так и «специальные» члены класса. Новое в версии 1.1. Изменено в версии 1.2: Опция теперь может принимать аргументы, т. Е. Специальные элементы для документирования.

Я пытаюсь перечислить __init__ класса в моей документации, но никаких других специальных пользователей, так мой .rst файл следующим образом:

**myClass Class** 
================== 

.. automodule:: python_module.submodule.series.myClass 
    :members: 

    .. autoclass:: myClass 
     :members: 
     :special-members: __init__ 

Я получаю ошибку».rst: 7: ВНИМАНИЕ! : отсутствует атрибут: специальные члены: инициализация в объекте python_module.submodule.series.myClass.myClass

Я использую сфинкс версию 1.5.1 так не должен эту работу, как я передал его имя из специальный член, который я хочу документировать? Ошибка в том, что мне кажется, что я пропускаю что-то ng из моего .py-файла Я вытаскиваю docstrings из. Это так? Я не могу найти никакого упоминания о том, что нужно особому желанию присутствовать в методе, если я хочу это сделать.

Answer 1

Я узнал, что повторение дважды повторяется дважды из-за секции ..автомодуля. Я взял его, и он по-прежнему включает в себя определение всего класса, что делает меня счастливым.

Я до сих пор не могу получить определение __init__, которое будет задокументировано с помощью опции: special-members: option, но это незначительная проблема, так как класс документирован достаточно адекватно. Так что, я думаю, я просто позволю этому предупреждению пнуть меня ... пока.