Как использовать Sphinx 'Autodoc-extension для частных методов?

Question

Я использую Sphinx для документирования моего проекта python. У меня включено расширение autodoc и в моих документах есть следующее.

.. autoclass:: ClassName 
    :members: 

Проблема заключается в том, что она только документирует non-private methods в классе. Как включить частные методы?

Answer 1

Вы пытались использовать custom method для определения того, должен ли член быть включен в документацию, используя autodoc-skip-member?

Answer 2

Вот подсказка: представьте, что частное означает «секрет».

Вот почему Сфинкс не будет документировать их.

Если вы не имеете в виду «секрет», подумайте об изменении их имен. Избегайте использования имени однодискового подчеркивания в целом; это не поможет, если у вас нет причин держать эту секрецию в секрете.

Answer 3

Нет, частные средства являются закрытыми для класса и не должны использоваться из общедоступного API. Это не означает секрет, и для тех из нас, кто хочет использовать сфинкс для полной документации классов, исключая частные методы, это довольно раздражает.

Предыдущий ответ верен. Вам придется использовать настраиваемый метод, поскольку Sphinx в настоящее время не поддерживает autodoc в сочетании с частными методами.

Answer 4

Один из способов обойти это - принудительно заставить Сфинкса документировать частные члены. Вы можете сделать это путем добавления automethod к концу Docs уровня класса:

class SmokeMonster(object): 
    """ 
    A large smoke monster that protects the island. 
    """ 
    def __init__(self,speed): 
     """ 
     :param speed: Velocity in MPH of the smoke monster 
     :type speed: int 

     .. document private functions 
     .. automethod:: _evaporate 
     """ 
     self.speed = speed 

    def _evaporate(self): 
     """ 
     Removes the smoke monster from reality. Not to be called by client. 
     """ 
     pass 

Answer 5

, если вы используете сфинкс 1.1 или выше, с документацией сайта сфинкса на http://sphinx.pocoo.org/ext/autodoc.html,

:special-members: 
:private-members: 

Answer 6

Глядя на apidoc code , мы можем изменить то, что сфинкс-apidoc генерировать установки переменной окружения:

export SPHINX_APIDOC_OPTIONS='members,special-members,private-members,undoc-members,show-inheritance' 

Вы также можете добавить эту установку в ваш Makefile (если ваш пакет использует один):

docs: 
    rm -rf docs/api 
    SPHINX_APIDOC_OPTIONS='members,special-members,private-members,undoc-members,show-inheritance' sphinx-apidoc -o docs/api/ intellprice 
    $(MAKE) -C docs clean 
    $(MAKE) -C docs html 

Answer 7

Вы можете добавить это conf.py файл:

autodoc_default_flags = ['members', 'undoc-members', 'private-members', 'special-members', 'inherited-members', 'show-inheritance']