我剛剛記錄了我的代碼,並學會了如何使用sphinx生成文檔。我想把它包含到我的github項目頁面中,但我不知道如何去做。有沒有人知道現有的教程或簡單的步驟來做到這一點?如何將從獅身人面像生成的html文檔上傳到github?
謝謝。
我剛剛記錄了我的代碼,並學會了如何使用sphinx生成文檔。我想把它包含到我的github項目頁面中,但我不知道如何去做。有沒有人知道現有的教程或簡單的步驟來做到這一點?如何將從獅身人面像生成的html文檔上傳到github?
謝謝。
github將爲您使用它們的靜態內容github pages功能。本質上,你創建一個名爲gh-pages的分支,你將靜態頁面提交到這個分支中。然後將這些頁面發送到you.github.com/yourproject。
請參閱http://pages.github.com/的說明。
您可能會遇到在github上使用Sphinx的問題,因爲Sphinx使用具有前導下劃線的目錄。您可以通過在生成的sphinx html目錄中添加一個名爲.nojekyll
的文件來解決此問題。
github-tools有一個功能正是做你所要求的:
paver gh_pages_create gh_pages_build
參考excellent documentation(當然使用本身)如何將其設置爲您的項目。
John Paulett's answer顯然是正確的,可能已經足夠用於大多數用戶(+1)。
或者你可能想看看本·威爾士的深入教程Sphinx documentation on GitHub,它提供了分步說明,以及一個方便Fabric基於腳本/任務捆綁那些在一起讓你開始快速發佈文檔旁邊代碼[。 ..]通過一個命令。
說明的鏈接已損壞。 – mac 2011-08-30 16:38:50
'.nojekyll'小費是挽救生命的。希望我早些時候讀過。進一步注意:將它添加到你的html樹的根目錄。 – Jayesh 2011-11-27 10:33:16
@Jayesh上面說過的鏈接:https://github.com/blog/572-bypassing-jekyll-on-github-pages – Gabriel 2014-04-10 01:45:51