本日は

Juliaの Documenter によるドキュメント生成を PkgTemplates から自動生成しドキュメントをGitHubPagesから閲覧できるようにする（前半）の続きです。

ローカルの環境で Documenter.jl によるドキュメントをソースコードの docstring をベースに生成することができました。今回はGitHubPagesにてそのドキュメントを公開する方法を紹介します。Travis CIと連携することでソースコードをプッシュして master ブランチにマージすることでドキュメントを更新自動で行うことができます。master にマージされないとドキュメントの自動更新はされないようです。

デプロイキーを作ります。

概要

Documenter.jl のドキュメントを読むとSSH Deploy Keys が必要になるようです。Overview にもあるように Travis CI は HTML に変換されたドキュメントを対象のリポジトリの gh-pages ブランチにプッシュしますので、GitHubリポジトリの操作を許可するためにもちいられるんだとおもいます。

DocumenterTools による鍵生成

DocumenterTools パッケージを導入します。

pkg> add DocumenterTools

つぎの手順でドキュメントを公開するみなさんのGitHubのリポジトリ用の鍵をつくります。

julia> using DocumenterTools
julia> Travis.genkeys(user="GitHubユーザ名", repo="git@github.com:GitHubユーザ名/リポジトリ名.git")
[ Info: add the public key below to ...
# リポジトリに配置する公開鍵
[ Info: add a secure environment variable named 'DOCUMENTER_KEY' to ...
# Travis CI の環境変数に追加するための値