sbt - scaladoc に追加のソース ディレクトリを指定する方法は?

Question

Eclipse と sbt の両方を使用する必要があるため、少し非標準の sbt ビルド セットアップがあります。

私のソースはsrc/main/scalaとsrc/com/companyname/[folder1, folder2, etc]ディレクトリにあります。

sbt をセットアップして、これらの追加folderXフォルダーのドキュメントも生成するようにするにはどうすればよいsrc/com/companynameですか?

Answer 1

tl;drで次を使用しますbuild.sbt。

unmanagedSourceDirectories in Compile += sourceDirectory.value

inspectあなたの友達です。

> inspect doc
[info] Task: java.io.File
[info] Description:
[info]  Generates API documentation.
[info] Provided by:
[info]  {file:/Users/jacek/sandbox/scaladoc/}scaladoc/compile:doc
[info] Defined at:
[info]  (sbt.Defaults) Defaults.scala:706
[info] Dependencies:
[info]  compile:doc::configuration
[info]  compile:doc::sources
[info]  compile:doc::apiMappings
[info]  compile:doc::target
[info]  compile:doc::fileInputOptions
[info]  compile:doc::streams
[info]  compile:doc::compilers
[info]  compile:doc::scalacOptions
[info]  compile:doc::dependencyClasspath
[info]  compile:doc::maxErrors
[info]  compile:doc::javacOptions
[info] Reverse dependencies:
[info]  *:copyDocAssetsTask
[info] Delegates:
[info]  compile:doc
[info]  *:doc
[info]  {.}/compile:doc
[info]  {.}/*:doc
[info]  */compile:doc
[info]  */*:doc
[info] Related:
[info]  test:doc

その下で、タスクが他のものに依存しDependenciesていることがわかります。再度設定してご利用ください。doccompile:doc::sourcesinspect

> inspect compile:doc::sources
[info] Task: scala.collection.Seq[java.io.File]
[info] Description:
[info]  All sources, both managed and unmanaged.
[info] Provided by:
[info]  {file:/Users/jacek/sandbox/scaladoc/}scaladoc/compile:sources
[info] Defined at:
[info]  (sbt.Defaults) Defaults.scala:187
[info] Reverse dependencies:
[info]  compile:doc
[info] Delegates:
[info]  compile:doc::sources
[info]  compile:sources
[info]  *:doc::sources
[info]  *:sources
[info]  {.}/compile:doc::sources
[info]  {.}/compile:sources
[info]  {.}/*:doc::sources
[info]  {.}/*:sources
[info]  */compile:doc::sources
[info]  */compile:sources
[info]  */*:doc::sources
[info]  */*:sources
[info] Related:
[info]  compile:sources
[info]  test:sources

以下Dependenciesに依存していることがわかり、それにcompile:sources沿って進むと、必要unmanagedSourceDirectoriesなものに設定を変更する必要があることがわかります。