sbt-siteと連携

sbt-siteのversion 1.2.1 でのデフォルトのディレクトリがsrc/paradoxのため、 設定を以下のように直す必要があります。

sourceDirectory in Paradox := sourceDirectory.value / "main" / "paradox",

また、scaladocも併せて見たい場合は、build.sbtに以下のpluginを追加することで、target/site/latest/apiが生成されます。

enablePlugins(SiteScaladocPlugin)

詳細は、Scaladocを参照してください。

paradoxで生成したドキュメントとScaladocを併せて生成したい時は、以下の設定を追加します。

    paradoxProperties ++= Map(
//      "scaladoc.base_url" -> "/latest/api/", /* preview */
      "scaladoc.base_url" -> "https://grimrose.github.io/scala-fukuoka-2017/latest/api/",

追加すると、@scaladoc[Fukuoka](org.grimrose.scala.fukuoka.Fukuoka$)が Fukuokaとして参照出来るようになります。

他のライブラリのscaladocへのリンクをしたい場合は、@scaladoc directiveを参照してください。

よく使うコマンド

sbt previewAutoは、ブラウザでpreviewしつつ、生成しながら作業が出来ます。

sbt makeSiteは、全てのドキュメントをtarget/siteへ生成します。