Размещение документации по сборке из запроса на GutHub

Question

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

Нажатие новых коммитов обновит сгенерированный документ для этого запроса извлечения.Вскоре мы добавим генерацию документов в нашу сборку travis, чтобы найти ошибки сфинкса, но окончательный визуальный обзор все равно придется выполнять локально, потянув ветку и сгенерировав ее локально.

Есть ли GitHub?приложение, которое предлагает разместить веб-страницу, созданную по запросу?

Answer 1

Вы можете создать свои собственные страницы обслуживания репозитория GitHub с помощью GitHub pages.

Если вы создаете документацию в gh-pages ветке или в подпапке doc/ вашей основной ветки, вы можете иметь как свою кодовую базу, так и документ в репо.

См., Например, lneuhaus / pyrpl Issue 85 , который иллюстрирует, как автоматизировать Документация Sphinx для Python

cd doc/sphinx
sphinx-apidoc -f -o source/ ../../pyrpl/
make html

Вы можете автоматизировать это, используя Syntaf/travis-sphinx:

Автономный скрипт для автоматизированной сборки и развертывания сфинксадокументы через travis-ci