scala - scaladoc 在哪里寻找 rootdoc.txt 来创建根文档

Question

这是Generate scaladoc for root package的副本，但是答案没有说明在哪里sbt doc查找rootdoc.txt.

我添加了

 scalacOptions in doc ++= Seq("-doc-root-content", "rootdoc.txt")

到我的build.sbt，但sbt doc似乎没有扫描它。我试图把它放在build.sbt, in src, src/main,旁边src/main/scala

我在用sbt 0.12.3

Answer 1

看来您的论点根本没有得到考虑scaladoc。我无法弄清楚为什么在限定范围时没有传递命令行参数doc，但是如果你不将其范围限定为但它可以doc工作Compile：

 scalacOptions in Compile ++= Seq("-doc-root-content", "rootdoc.txt")

在rootdoc.txt项目的根目录下。

Answer 2

您应该使用绝对文件路径：

scalacOptions in doc <++= baseDirectory map { d =>
  Seq("-doc-root-content", d / "rootdoc.txt" getPath)
}

这将使 scaladoc 在项目的根目录中查找 rootdoc.txt，也就是 build.sbt 旁边

Answer 3

正确的解决方案似乎是

settings(
   // Get scaladoc to add rootdoc.txt content to index.html
   scalacOptions in (Compile,doc) ++= Seq("-doc-root-content", "rootdoc.txt")
).

照顾https://github.com/pnerg/sbt-scaladoc-settings-plugin/blob/master/README.md

这让我很难过，这很难弄清楚。