我需要从我的scaladoc链接到github上的源代码。我使用sbt的doc
任务构建这些文档。
有两个问题 - 首先,我不喜欢为我的.scala
文件创建几个嵌套的空目录,因此我通常将它们全部打包在一起 - 例如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/")
docs包含指向源的链接,但所有这些链接只指向源根URL,而不是文件本身。我做错了什么?
答案 0 :(得分: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