Проект Numpy предоставляет спецификацию форматирования их документации для обеспечения читаемости и автоматического извлечения (link). Они также предоставляют Numpydoc в качестве расширения для Sphinx для поддержки некоторых дополнительных ключевых слов.NumpyDoc Проверка соответствия спецификации doc?
Прежде чем приступать к написанию расширения для docutils, существует ли библиотека, помогающая исследовать существующие docstrings и идентифицировать несоответствие стандарту Numpy.
Изображение более зрелой библиотеки с обширной документацией, которая хотела бы принять спецификацию документации Numpy. Одним из подходов было бы интроспекцию библиотеки и создание отчета, описывающего состояние строк документа.
Это вопрос разведки, прежде чем начинать реализацию этого как расширение докутилов или numpydoc. Я пропустил существующее решение или существует ли элегантное решение?
Я не знаю о существующем решении, но мне было бы очень интересно это! – joris