Question

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

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

我需要帮助的是镜像来自/docs分支的master路径中的html文件，因此它们位于gh-pages分支的根目录中。接近这个的最佳方式是什么？

Answer 1

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

我基本上复制了detailed in this sake task，但总结如下：

将docs路径移至临时文件夹中。提交更改。
根据usual instructions

gh-pages

将所有内容从temp文件夹移动到新的gh-pages分支。提交更改。
返回主分支，将远程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分支，并按照here的说明创建。

Answer 3

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

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

3 个答案: