Простой способ конвертировать строки документации Python из реструктурированного текста в стиль Google?

Question

Кто-нибудь теперь простой способ конвертировать все строки документации в существующем проекте из reStructured Text в формат Google?

Похоже, что Наполеон может сделать что-то подобное, но это выглядит очень сложно, поэтому я решил спросить, делал ли это кто-то раньше. Любая идея будет высоко ценится.

Answer 1

Попробуйте использовать pyment для преобразования строк документации из reStructuredText в формат Google. Затем используйте Napolean для генерации документации через Sphinx.

Napoleon - это препроцессор, который анализирует строки документов в стиле NumPy и Google и преобразует их в reStructuredText до того, как Sphinx попытается их проанализировать.

Answer 2

А также естьdocconvertна https://github.com/cbillingham/docconvert.

Я лично обнаружил, что он работает намного лучше;

• лучший отступ и перенос строк (личный выбор)
• справился со строками документации, которые представляли собой смесь стилей Google и reSTructured в одной и той же строке документации!