Как говорится в документации GitHub, «GitHub Pages — это служба размещения статических сайтов, которая принимает файлы HTML, CSS и JavaScript прямо из репозитория в GitHub, при необходимости выполняет файлы с помощью процесса сборки и публикует веб-сайт».
Прежде чем публиковать свою документацию на GitHub Pages, убедитесь, что ваши файлы документации находятся в каталоге zen/_build/html вашего репозитория, например:
Если вы создали свой репозиторий на основе шаблона демонстрационного репозитория, все необходимые файлы уже находятся в каталоге zen/_build/html.
Чтобы опубликовать файлы из этого каталога на GitHub Pages:
Откройте настройки вашего репозитория.
Выберите Pages.
В разделе Build and deployment в разделе Source выберите GitHub Actions.
В Static HTML нажмите Configure.
GitHub создает для вас файл .github/workflows/static.yml.
В файле static.yml найдите элемент path, он должен выглядеть следующим образом:
# Upload entire repositorypath:'.'
Измените его следующим образом:
# Upload _build/htmlpath:'./zen/_build/html'
Нажмите Start commit, а затем Commit new file.
Как только static.yml будет зафиксирован, GitHub немедленно начнет публиковать ваш сайт документации. Процесс публикации может занять некоторое время, и когда он будет завершен, вы можете открыть свою документацию, нажав Visit site в Settings -> Pages:
