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

Question

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

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

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

Answer 1

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

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

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

Answer 2

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

Answer 3

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