Sphinx и argparse - автодокументирование скриптов командной строки?
Я создаю пакет Python и использую Sphinx для создания документации. Помимо кода пакета, я также включаю множество скриптов командной строки Python, которые используют argparse. Мне интересно, есть ли способ заставить Sphinx автодокументировать эти скрипты? Конечной целью был бы красиво напечатанный список скриптов, с соответствующим выводом справки, аргументами и опциями. И чтобы быть ясным, я ищу уже существующий способ сделать это, а не способ реализовать это самостоятельно.
Это'не такой специфический вопрос, как я обычно задаю на S.O., если есть более подходящий S.E. сайт для размещения этого вопроса, пожалуйста, дайте мне знать. Спасибо.
Используйте расширение sphinx-argparse:
Вы можете использовать sphinxcontrib.programoutput для включения справочных сообщений из командной строки в вашу документацию.
Это не относится к argparse, но может быть использовано для документирования любого скрипта, выводящего справочные сообщения в командную строку.
Вы можете использовать sphinxcontrib.autoprogram. pip install sphinxcontrib-autoprogram, затем поставьте
extensions += ['sphinxcontrib.autoprogram']в вашем conf.py. Чтобы документировать команду cli.py, импортировав cli с объектом argparse parser (который может быть выражением Python, как функция get_parser()), используйте
.. autoprogram:: cli:parser
:prog: cli.py
