Я не могу правильно добавить свой файл __main__.py и его функции при создании файла RST с sphinx-apidoc . Другие файлы и класс генерируются правильно.
Я работаю, только если я запускаю sphinx-apidoc с параметром -P
, который включает в себя частные модули. Но я не хочу добавлять приватные методы других модулей, они нужны только из __main__.py.
__ main__.py выглядит так:
def main():
"""
main() description here
"""
f1()
f2()
if __name__ == '__main__':
main()
Я бы хотел, чтобы main()
, f1()
и f2()
были включены в RST-файлы, генерируемые sphinx-apidoc.
Есть похожий вопрос Документирование записи скрипта Python (__name__ == '__main__') с использованием sphinx , но он не отвечает на мой вопрос.