Документы Sphinx, включая результаты модульного теста - PullRequest
1 голос
/ 23 июня 2019

Это вопрос с практическими рекомендациями.

  • У меня есть кодовая база с набором модульных тестов, запущенных с pytest
  • У меня есть набор *.rst файлов, которые предоставляют объяснение каждого теста вместе с таблицей результатов и изображениями некоторых математических графиков
  • Каждый раз, когда запускается набор pytest, он динамически обновляет файлы *.rst с результатами последних тестовых данных, обновляя числовые значения, отмечая метки времени тестов и т. Д.

Я хотел бы интегрировать это с документами проекта. Я мог

  • Создайте эти первые файлы отдельно с помощью sphinx-build всякий раз, когда я хочу просмотреть результаты теста [это кажется плохим, поскольку он трудоемкий и не автоматизирован]
  • попросить Sphinx отрисовывать эти страницы отдельно и включать их в документацию проекта [лучше, но я не уверен, как это настроить]
  • имеет отдельный набор документов sphinx для результатов теста, которые я могу построить после каждого запуска набора тестов

Какой подход (или другой подход) наиболее эффективен? Есть ли лучшая практика для подобных вещей?

...