Извлеките строку документации в стиле Google в класс данных, используя Sphinx NapoléonPython

Программы на Python
Anonymous
Извлеките строку документации в стиле Google в класс данных, используя Sphinx Napoléon

Сообщение Anonymous »

Я пытаюсь программно принять («отразить») строки документации в стиле Google. Я использую sphinx.ext.napoleon, поскольку, похоже, не многие инструменты делают это. Я следую этому примеру с помощью приведенной ниже функции:

Код: Выделить всё

from sphinx.ext.napoleon import Config, GoogleDocstring

def foo(arg: int | None = 5) -> None:
"""Stub summary.

Args:
arg(int): Optional integer defaulted to 5.
"""

docstring = GoogleDocstring(foo.__doc__)
print(docstring)
Однако мое использование не преобразует печатный вывод автоматически в стиль reST, как это делает пример Sphinx.
И это подводит меня к моему вопросу. . Как можно программно получить сводку, расширенное описание, имена аргументов и описания аргументов из строки документации Google Style? В идеале они преобразуются в какую-то структуру данных (например, dict или dataclass).

Подробнее здесь: https://stackoverflow.com/questions/786 ... x-napoleon

Вернуться в «Python»