Swiftの詳細設計をドキュメントツール「Jazzy」で作成するメモ

２度目でも大概てこずったのでメモ。

まずはJazzyをgemでインストール

sudo gem install jazzy

バージョン確認↓　入ったバージョンは0.13.5

jazzy -v

発行した対象のプロジェクトファイルのルートディレクトにて、
最終的には下記コマンドで発行成功（ちなみにこれはxcworkspaceの場合）。

jazzy --min-acl private -c  -o docs --author Digital Standard  --author_url https://digital-standard.com/--module testProject --xcodebuild-arguments -workspace,testProject.xcworkspace,-scheme,testProject

このコマンドに行き着くまでが時間かかった。
自分にとって最も参考になったのがこちらのページ
[iOS][Swift] 「Jazzy」を使ってSwiftのソースファイルからドキュメントを生成する

だが、このコマンドに行き着くまでもいろいろあって、
書き込み権限が無いと怒られたこともあった。
→　rbenvでrubyを管理するとうまくいった。
詳細はgem installでpermissionエラーになった時の対応方法

大体は上記ページのコマンドをコピペで行けるか、自分の環境の場合、シェルはbashだったのでパスを通す時は.bash_profileをviで開いて
末尾に下記コードを追記する形になった。

[[ -d ~/.rbenv  ]] && \
  export PATH=${HOME}/.rbenv/bin:${PATH} && \
  eval "$(rbenv init -)"

これでパーミッションエラーは回避した。

で、次がSwiftのバージョン指定も間違えて怒られた。
Xcodeのビルドのバージョン調べてやってたのだが、そうではなく
これは普通にターミナルでSwiftのバージョンを調べて打ち込めばそれで良い。

大体こんなとこか。
もー、この作業ではつまづきたく無いな。
以上、どどん。