Как создать страницы GitHub из документации проекта?
-
27-10-2019 - |
Вопрос
У меня есть проект на GitHub, в котором есть каталог, содержащий некоторую автоматически сгенерированную документацию HTML. Я хотел бы использовать эту документацию на объекте проектов Github.
Итак, я прочитал инструкции о том, как Создать корневую филиал Project GH-Pages. Анкет Это эффективно создает пустую ветвь.
Что я хотел бы помочь, так это отражение HTML -файлов в /docs
путь от master
ветвь, поэтому они находятся в корне gh-pages
ответвляться. Какой лучший способ приблизиться к этому?
Решение
Отвечая на мой собственный вопрос здесь ... достигли того, что я хотел с подмодурами GIT.
Я в основном скопировал то, что подробно в этой задаче, но, в итоге:
- Переместил
docs
Путь в папку с температурой. Совершить изменения. - Создал чистую
gh-pages
ветвь в соответствии с обычные инструкции - Переместил все от папки Temp в новую
gh-pages
ответвляться. Совершить изменения. - Вернувшись в главную ветку, добавьте пульт дистанционного управления
gh-pages
как подмодуль вdocs
папка. - Совершить изменения. Вуаля!
Другие советы
MHM, я закончил тем, что написал эти две цели Makefile, чтобы подтолкнуть мои документы. Я просто делаю обновление DOC, и это обычно работает.
TMP_PATH="/tmp/some_path"
## the dir containing HTML docs to push to gh-pages
HTML_DIR="html"
## arbitrary dirs created by the doc build system that should be removed
TRASH=latex
update-doc: doc
rm -rf ${TMP_PATH} && cp ${HTML_DIR} ${TMP_PATH} -R && rm -rf ${HTML_DIR}
git fetch
git checkout gh-pages
cp ${TMP_PATH}/* . -R
rm -rf ${TRASH}
git add .
git commit -m "Update documentation"
git push -u origin gh-pages
rm -rf ${TMP_PATH}
git checkout master
# command to build documentation; can be customised but
# remember to also change the HTML_DIR and TRASH variables
doc:
doxygen docs/doxygen.conf
.PHONY: doc update-doc
я использую doxygen
Но вы можете изменить это на любую другую систему документации.
Это предполагает gh-pages
ветвь существует на удаленном дистанционном управлении и была создана, как объяснено здесь.
Создайте символики для этих файлов в это место. Вы должны быть в состоянии совершить их тоже.