Sphinx - получить документацию по функциям без подписи

У меня есть скрипт на Python, который я документирую с помощью Sphinx. Одним из входных данных для скрипта является текстовый файл, который я анализирую в отдельной функции, скажем, parse_file(f), Документ для parse_file где этот текстовый формат задокументирован. Я документирую аргументы командной строки, используя sphinx-argparse. Так что мой RST выглядит примерно так:

.. argparse::
    :module: mypkg.my_script
    :func: get_parser
    :prog: my_bash_wrapper.sh

.. autofunction:: mypkg.my_script.parse_file

Я получаю почти то, что хочу, но очевидно, что функция имеет подпись в документации, но пользователям моей командной строки это не нужно. Я просмотрел документацию по autodoc и есть много способов переопределить подпись на какую-то другую подпись, но все, похоже, требуют некоторого реального содержимого, а не пустой строки. Я не могу найти способ не иметь подписи.

Кто-нибудь знает способ получить то, что мне нужно, или я должен прибегнуть к помещению функции docstring в сфинкса? Заранее спасибо.

0 ответов

Другие вопросы по тегам