Документирование записи сценария python (__name__ == '__main__') с использованием sphinx

Question

Есть ли способ, в идеале с использованием autodoc, чтобы получить sphinx для документирования скрипта Python? Часть сценария, я хочу задокументирована часть защищена:

if __name__ == '__main__': 

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

Answer 1

Вы должны извлечь код в этом блоке в функцию с помощью docstring и вызвать эту функцию из блока.