如何從項目文檔創建Github頁面？

我在Github上有一個項目，它有一個包含一些自動生成的HTML文檔的目錄。我想在Github的項目頁面工具中使用該文檔。如何從項目文檔創建Github頁面？

所以，我已閱讀關於如何create the project's gh-pages root branch的說明。這有效地創建了一個空分支。

我想幫忙的是鏡像/docs分支中的/docs分支的HTML文件，因此它們位於gh-pages分支的根目錄中。接近這個最好的方法是什麼？

2011-06-14 aaronrussell

請參閱[我的相關答案]（http://stackoverflow.com/a/29616287/946850）和[writeup]（http://krlmlr.github.io/git-subbranch）。 – krlmlr 2015-04-13 22:53:04

[git branch：gh-pages]可能的重複（http://stackoverflow.com/questions/4750520/git-branch-gh-pages） – 2016-08-18 17:49:08

嘿@Martijn彼得斯，我很好，你刪除我的帖子一旦問題是關閉的。到目前爲止，這個還沒有。 – 2016-08-19 21:45:47

在這裏回答我自己的問題...已經實現了我想要的Git子模塊。

我基本上是複製什麼detailed in this sake task，但總結：

移動docs路徑到一個臨時文件夾中。提交更改。
創建一個乾淨gh-pages分支爲每usual instructions
感動一切從臨時文件夾到新gh-pages分支。提交更改。
回到主分支，在docs文件夾中添加遠程gh-pages作爲子模塊。
提交更改。瞧！

來源

2011-06-15 11:32:11 aaronrussell

您是否必須將'cd'放入'docs'文件夾並單獨提交/推送所有內容，或者是否有一種方法可以使用根目錄中的單個命令執行此操作？ – 2011-09-02 02:08:28

您是否必須使用這種方法將每個更新到'gh-pages'到你的子模塊？它在實踐中運作良好嗎？ – krlmlr 2015-04-13 22:54:23

爲這些文件創建符號鏈接。你也應該能夠承諾這些。

來源

2011-06-15 02:48:51

姆姆，我最終寫了這兩個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分支存在於遠程並且按照解釋here創建。

來源

2015-11-05 18:18:43

如何從項目文檔創建Github頁面？

回答

相關問題