В настоящее время я пытаюсь реализовать автоматическое создание документации с помощью Sphinx (используя расширения sphinx-apidoc и napoleon). Это работает достаточно хорошо, но было бы еще лучше, если бы подсказки типов (соглашение PEP484) автоматически добавлялись в список параметров.
Мне было интересно, возможно ли это.
Более конкретно: (из примера Наполеона)
def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
"""Example function with PEP 484 type annotations.
Args:
param1: The first parameter.
param2: The second parameter.
Returns:
The return value. True for success, False otherwise.
"""
Это выглядит следующим образом:
Список параметров содержит все параметры, но не прикрепляет типы. Их можно добавить вручную, но это может привести к проблемам в будущем, когда будет принято решение об изменении подписи.
Пример с ручным добавлением типа:
def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
"""Example function with PEP 484 type annotations.
Args:
param1 (int): The first parameter.
param2 (str): The second parameter.
Returns:
The return value. True for success, False otherwise.
"""
который отображается как:
