如何从项目文档创建 GitHub 页面？

Question

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

因此，我已阅读有关如何创建项目的 gh-pages 根分支的说明。这有效地创建了一个空分支。

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

Answer 1

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

我基本上复制了此清酒任务中详细说明的内容 ，但总而言之：

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

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

为这些文件创建到该位置的符号链接。您也应该能够做出这些承诺。