You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sr...@apache.org on 2015/10/16 13:03:18 UTC
spark git commit: [SPARK-11092] [DOCS] Add source links to scaladoc
generation
Repository: spark
Updated Branches:
refs/heads/master 43f5d1f32 -> ed775042c
[SPARK-11092] [DOCS] Add source links to scaladoc generation
Modify the SBT build script to include GitHub source links for generated Scaladocs, on releases only (no snapshots).
Author: Jakob Odersky <jo...@gmail.com>
Closes #9110 from jodersky/unidoc.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/ed775042
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/ed775042
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/ed775042
Branch: refs/heads/master
Commit: ed775042cceb61a0566502e1306ac3c70f4a6a5f
Parents: 43f5d1f
Author: Jakob Odersky <jo...@gmail.com>
Authored: Fri Oct 16 12:03:05 2015 +0100
Committer: Sean Owen <so...@cloudera.com>
Committed: Fri Oct 16 12:03:05 2015 +0100
----------------------------------------------------------------------
project/SparkBuild.scala | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/ed775042/project/SparkBuild.scala
----------------------------------------------------------------------
diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala
index 1339980..8f0f310 100644
--- a/project/SparkBuild.scala
+++ b/project/SparkBuild.scala
@@ -156,6 +156,10 @@ object SparkBuild extends PomBuild {
javacOptions in Compile ++= Seq("-encoding", "UTF-8"),
+ scalacOptions in Compile ++= Seq(
+ "-sourcepath", (baseDirectory in ThisBuild).value.getAbsolutePath // Required for relative source links in scaladoc
+ ),
+
// Implements -Xfatal-warnings, ignoring deprecation warnings.
// Code snippet taken from https://issues.scala-lang.org/browse/SI-8410.
compile in Compile := {
@@ -489,6 +493,8 @@ object Unidoc {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/hive/test")))
}
+ val unidocSourceBase = settingKey[String]("Base URL of source links in Scaladoc.")
+
lazy val settings = scalaJavaUnidocSettings ++ Seq (
publish := {},
@@ -531,8 +537,19 @@ object Unidoc {
"-noqualifier", "java.lang"
),
- // Group similar methods together based on the @group annotation.
- scalacOptions in (ScalaUnidoc, unidoc) ++= Seq("-groups")
+ // Use GitHub repository for Scaladoc source linke
+ unidocSourceBase := s"https://github.com/apache/spark/tree/v${version.value}",
+
+ scalacOptions in (ScalaUnidoc, unidoc) ++= Seq(
+ "-groups" // Group similar methods together based on the @group annotation.
+ ) ++ (
+ // Add links to sources when generating Scaladoc for a non-snapshot release
+ if (!isSnapshot.value) {
+ Opts.doc.sourceUrl(unidocSourceBase.value + "€{FILE_PATH}.scala")
+ } else {
+ Seq()
+ }
+ )
)
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org