SphinxドキュメントをGitHub Pagesで公開する手順を調べた
タイトルの通り。
- mastarブランチのdocフォルダは使わない
- ビルド結果ファイルは
gh-pages
ブランチにのみ登録
という縛り。
結局以下のサイトに書かれている通りなんだけど、Git方面の知識も足りず、色々ハマった。
submodule
やsubtree
やworktree
等いろんな方法にあたって結局submodule
に戻ってきた格好。
長くなったのでGistに書いた。
GitHub PagesでSphinxドキュメントを公開する手順 · GitHub
自分より詳しくない人が見ても出来るように書いたら、長くなりすぎた。。。
(ニッチなテーマなので、もう少し端折って書いたほうが、この必要としている人にとっては分かりやすかったかもしれない)