git - 如何从项目的文档中创建 Github 页面？

Question

我在 Github 上有一个项目，该项目的目录包含一些自动生成的 HTML 文档。我想在 Github 的项目页面工具中使用该文档。

所以，我已经阅读了关于如何创建项目的 gh-pages root branch的说明。这有效地创建了一个空分支。

我需要帮助的是/docs从分支镜像路径中的 html 文件master，因此它们位于gh-pages分支的根目录中。解决这个问题的最佳方法是什么？

Answer 1

在这里回答我自己的问题......已经通过 Git 子模块实现了我想要的。

我基本上复制了这个清酒任务中的详细内容，但总结一下：

• 将路径移动docs到临时文件夹中。提交更改。
• gh-pages按照通常的说明创建了一个干净的分支
• 将临时文件夹中的所有内容移到新gh-pages分支中。提交更改。
• 回到主分支，将遥控器添加为文件夹gh-pages中的子模块。docs
• 提交更改。瞧！

Answer 2

嗯，我最终编写了这两个 Makefile 目标来推送我的文档。我只是做更新文档，它通常可以工作。

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

为这些文件创建指向该位置的符号链接。你也应该能够提交这些。