Как создать страницы Github из проектной документации?

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

Итак, я прочитал инструкции о том, как создать корневой ветвь gh-страниц проекта. Это эффективно создает пустую ветвь.

Я хочу помочь с зеркалированием html файлов в пути /docs из ветки master, поэтому они находятся в корневой части ветки gh-pages. Каков наилучший способ приблизиться к этому?

Ответы

Ответ 1

Отвечая на мой собственный вопрос здесь... достиг того, чего я хотел с подмодулями Git.

Я в основном скопировал то, что подробно описано в этой программе цели, но в целом:

  • Переместил путь docs во временную папку. Зафиксировать изменения.
  • Создал чистую ветвь gh-pages в соответствии с обычными инструкциями
  • Перемещено все из папки temp в новую ветвь gh-pages. Зафиксировать изменения.
  • Вернитесь в главную ветвь, добавьте удаленный gh-pages в качестве подмодуля в папку docs.
  • Зафиксировать изменения. Вуаля!

Ответ 2

Mhm, я закончил писать эти две цели Makefile, чтобы подтолкнуть мои документы. Я просто делаю update-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 существует на удаленном компьютере и была создана, как описано здесь.

Ответ 3

создайте символические ссылки для этих файлов на это место. Вы также сможете их совершить.