Как получить документацию Python Sphinx в формате только данных?

Я работаю над очень большой базой кода, которая использует sphinx-apidoc для автоматического создания HTML-документации из строк документации в исходном коде Python. Строки документации используют следующий формат:

: param message: сообщение для отображения
: type message: string
: returns: formatted string
: rtype: string

Стало обязательным заменить документацию Sphinx HTML чем-то, что организовано / представлено иначе, но мы по-прежнему хотим автоматически генерировать из наших строк документации в исходном коде. Есть ли способ сгенерировать документацию в промежуточном (например, xml) формате с помощью Sphinx? Я не нашел способа сделать это. Кто-нибудь знает, что я могу сделать?


person protonpopsicle    schedule 26.10.2012    source источник


Ответы (1)


Вы можете использовать конструктор json вместо конструктора HTML, который будет выдавать анализируемый вывод JSON. В качестве альтернативы вы можете написать свой собственный конструктор для создания нужного вам формата (см. https://www.sphinx-doc.org/en/master/usage/builders/index.html для просмотра текущего списка разработчиков).

person epc    schedule 26.10.2012