Подключите Sphinx autodoc-skip-member к моей функцииPython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Подключите Sphinx autodoc-skip-member к моей функции

Сообщение Anonymous »

Я хочу использовать событие autodoc-skip-member Sphinx, чтобы выбрать часть членов определенного класса Python для документации.

Но это неясно из документации сфинкса, и я не могу найти примеров, иллюстрирующих: где мне поместить код, чтобы это связать? Я вижу Sphinx.connect и подозреваю, что он есть в моем conf.py, но когда я пробую варианты этого кода в conf.py, я не могу найти объект приложения, к которому мне следует подключиться():

Код: Выделить всё

def maybe_skip_member(app, what, name, obj, skip,
options):
print app, what, name, obj, skip, options
return False

# This is not even close to correct:
#from sphinx.application import Sphinx
#Sphinx().connect('autodoc-skip-member', maybe_skip_member)
Идеальным вариантом будет указатель на простой пример.

Подробнее здесь: https://stackoverflow.com/questions/375 ... y-function
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «Python»