読者です 読者をやめる 読者になる 読者になる

日曜プログラミング

休日趣味でやってるプログラミング関連記事をダラダラと

codox を使った GitHub へのもう少し手抜きな API doc 公開方法メモ

GitHubAPI doc を deploy する方法としては既に codox の HowTo としてもあるんだが、ここではもう少し手抜きな方法をメモしておく。GitHub Pages となるリポジトリは既に作っているものとする。

  1. lein doc してできた doc フォルダを普通に git commit&push
  2. codox でドキュメント作ってるプロジェクトの GitHub リモートリポジトリで gh-pages の名前のブランチを切る
    • どこでやるかは公式Create a gh-pages branch参照
  3. 10 分ほど待つ
  4. http://your-account.github.io/your-project/doc/ にアクセス

後はプロジェクトリポジトリの README.md とか適当な所にリンクを張れば終了。

試してみた例

これだけ。API doc の URL がプロジェクト名直下でないとヤダとかでなければ Deploying to GitHub Pages に書かれているようなコマンドライン打つ必要が無い分だけちょっと楽。

git とコマンドライン少し詳しければこの手順取らなくてもバッチなりシェルスクリプトなりで 対応可能かもしれんけどまあ一つの方法として参考になれば。