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

eit6fx6z  于 2022-12-10  发布在  Git
关注(0)|答案(3)|浏览(166)

我在GitHub上有一个项目,它有一个包含一些自动生成的HTML文档的目录。我想在GitHub的项目页面工具中使用这些文档。
所以,我已经阅读了关于如何创建项目的gh-pages根分支的说明,这实际上创建了一个空分支。
我希望得到的帮助是从master分支镜像/docs路径中的html文件,这样它们就位于gh-pages分支的根目录中。

093gszye

093gszye1#

在这里回答我自己的问题...已经实现了我想要的Git子模块。
我基本上复制了detailed in this sake task的内容,但总的来说:

  • 已将docs路径移至缓存文件夹。认可变更。
  • 按照常规说明创建了一个干净的gh-pages分支
  • 已将临时文件夹中的所有内容移动到新的gh-pages分支中。提交更改。
  • 回到master分支,将远程gh-pages作为子模块添加到docs文件夹中。
  • 提交更改。瞧!
rjee0c15

rjee0c152#

嗯,我最后写了这两个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得说明创建了该分支.

h6my8fg2

h6my8fg23#

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

相关问题