8

scaladocからgithubのソースにリンクする必要があります。私はsbtのdocタスクでそれらのドキュメントを作成します。

2つの問題があります-最初に、ファイル用にネストされた空のディレクトリをいくつか作成するのは好きではない.scalaので、通常はすべてを1つにまとめます-のsrc/main/scala/org.rogach.scallop代わりにsrc/main/scala/org/rogach/scallop。そのディレクトリを分割せずにドキュメントへのリンクを機能させる方法はありますか？

次に、この行をbuild.sbtに配置すると、次のようになります。

scalacOptions in (Compile, doc) ++=
  Opts.doc.sourceUrl("https://raw.github.com/Rogach/scallop/master/src/main/scala/")

ドキュメントにはソースへのリンクが含まれていますが、これらのリンクはすべて、ファイル自体ではなく、ソースのルートURLを指しているだけです。私は何が間違っているのですか？

4

1 に答える 1

7

の出力からscaladoc help:

-doc-source-url <url>        A URL pattern used to build links to template
                             sources; use variables, for example:
                               €{TPL_NAME} ('Seq'),
                               €{TPL_OWNER} ('scala.collection'),
                               €{FILE_PATH} ('scala/collection/Seq')

(はい、それはユーロ記号です。)

すべてのソースがパッケージで定義されている場合、次のようなものが sourceUrl の引数として機能するはずです。

https://raw.github.com/Rogach/scallop/master/src/main/scala/€{TPL_OWNER}.€{TPL_NAME}.scala
于 2012-05-02T23:27:45.127 に答える