GitHub Pagesを使って文書を管理したら快適そうだったので試してみた。

ゆるふわHaskellというものを書いてます。

Haskellで人工無脳をつくってみたいとか、PLEAC埋めたいとか、Invent with Pythonを書きなおしてみたいとか色々あったのでGitHub+Sphinxでやりたくなったというのがモチベーション。

基本的な流れとしては

1. gh-pagesというブランチを作る
2. sphinxtogithubというエクステンションを入れる
3. Sphinxで文章を書く
4. make htmlする
5. cp -pr _build/html/* ./でビルドされたhtmlをカレントディレクトリに移動する
6. commitしてpushすると公開できるようになる

となるが、4-5のステップはもうちょっとスマートにできると思う。ちなみに参考にしたのが以下のサイトだけど、オフィシャルのヘルプには一通り目を通しておくといいと思う。

• Creating Project Pages manually
• github pages に Sphinx で生成したドキュメントを公開する
• github のプロジェクトにSphinxドキュメントを良さげな感じにおきたい 其の一

GitHub+Sphinxのよさそうなところ(要検証)

• Issueの管理が楽
• pull requestで変更を取り込める
• コードの管理するよりソーシャルなやり取りの敷居が低そう