Можно ли скрыть аргументы функции Python в Sphinx?
Предположим, что у меня есть следующая функция, которая документирована в стиле Numpydoc , и документация автоматически генерируется с помощью директивы autofunction Sphinx :
def foo(x, y, _hidden_argument=None): """ Foo a bar. Parameters ---------- x: str The first argument to foo. y: str The second argument to foo. Returns ------- The barred foo. """ if _hidden_argument: _end_users_shouldnt_call_this_function(x, y) return x + y Я не хочу рекламировать скрытый аргумент как часть моего публичного API, но он появляется в моей автоматической сгенерированной документации. Есть ли способ сказать Sphinx игнорировать конкретный аргумент функции, или (еще лучше) сделать это автоматически игнорировать аргументы с лидирующим подчеркиванием?
- Система документации Sphinx – множественные замены с rst_prolog
- Как опустить значения переменных на Sphinx?
- Как переопределить параметры конструктора в Sphinx с помощью autodoc?
- Есть ли интеллектуальный редактор для файлов ReST?
- Autodoc params?
Я не думаю, что в Sphinx есть вариант. Одним из возможных способов добиться этого без необходимости взломать код является использование настраиваемой подписи.
В этом случае вам нужно что-то вроде:
.. autofunction:: some_module.foo(x, y)
Это переопределит список параметров функции и спрячет нежелательный аргумент в документе.
Можно редактировать сигнатуру функции в обработчике события автоподкодирования.
Параметр signature обработчика событий содержит подпись; строка формы (parameter_1, parameter_2) . В приведенном ниже фрагменте split() используется для удаления последнего параметра функции:
hidden = "_hidden_argument" def process_sig(app, what, name, obj, options, signature, return_annotation): if signature and hidden in signature: signature = signature.split(hidden)[0] + ")" return (signature, return_annotation) def setup(app): app.connect("autodoc-process-signature", process_sig)
В результате документация покажет подпись функции в вопросе как foo(x, y) вместо foo(x, y, _hidden_argument=None) .
- Список Python () против скорости построения списка
- Alembic – автогенератор, производящий пустую миграцию
- Python – как НЕ сортировать вывод Sphinx в алфавитном порядке
- Sphinx-doc: автомодуль: с импортом макетов
- Создание большой таблицы сначала с вложенными заголовками столбцов и получение рендеринга латекса для обертывания текста заголовка
- Использование sphinx с Markdown вместо RST
- Практично ли поставить Python под контроль версий?
- получение сфинкса для распознавания правильной подписи
- Как работает «autodoc_default_flags» в конфигурации python Sphinx?
- Sphinx autodoc дает ПРЕДУПРЕЖДЕНИЕ: py: целевая ссылка класса не найдена: введите предупреждение
- Sphinx: список функций в модуле