プロジェクトのドキュメントからgithubページを作成する方法は？

Question

GitHubには、自動的に生成されたHTMLドキュメントを含むディレクトリがあるプロジェクトがあります。 GitHubのProject Pages施設内でそのドキュメントを使用したいと思います。

それで、私は方法についての指示を読みました プロジェクトのGH-Pagesルートブランチを作成します. 。これにより、空の枝が効果的に作成されます。

私が助けたいのは、のHTMLファイルをミラーリングすることです /docs からの道 master ブランチなので、彼らは gh-pages ブランチ。これにアプローチする最良の方法は何ですか？

Answer 1

ここで自分の質問に答えてください... Gitサブモジュールで私が望んでいたことを達成しました。

私は基本的に何をコピーしました この酒の仕事で詳述されています, 、しかし要約する：

• 動いた docs 温度フォルダーへのパス。変更をコミットします。
• クリーンを作成しました gh-pages に従ってブランチ 通常の指示
• Tempフォルダーから新しいフォルダーにすべてを移動しました gh-pages ブランチ。変更をコミットします。
• マスターブランチに戻って、リモコンを追加します gh-pages のサブモジュールとして docs フォルダ。
• 変更をコミットします。出来上がり！

Answer 2

MHM、私はこれらの2つの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 ブランチはリモートに存在し、説明されているように作成されました ここ.

Answer 3

それらのファイルのシンリンクをその場所に作成します。あなたもそれらをコミットできるはずです。