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
3条答案
按热度按时间093gszye1#
在这里回答我自己的问题...已经实现了我想要的Git子模块。
我基本上复制了detailed in this sake task的内容,但总的来说:
docs
路径移至缓存文件夹。认可变更。gh-pages
分支gh-pages
分支中。提交更改。gh-pages
作为子模块添加到docs
文件夹中。rjee0c152#
嗯,我最后写了这两个Makefile目标来推送我的文档。我只是做了update-doc,它通常是有效的。
我使用
doxygen
,但是您可以将其更改为任何其他文档系统。这假定远程数据库上存在
gh-pages
分支,并且按照here得说明创建了该分支.h6my8fg23#
为这些文件创建指向该点的符号链接。你应该也能够提交这些文件。