[SPARK-23732] Broken link to scala source code in Spark Scala api Scaladoc

• Type: Bug
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.3.0, 2.3.1
• Fix Version/s: 2.1.3, 2.2.2, 2.3.2, 2.4.0
• Component/s: Build, Documentation, Project Infra
• Labels: build documentation scaladocs

Environment

~/spark/docs$ cat /etc/*release*
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=16.04
DISTRIB_CODENAME=xenial
DISTRIB_DESCRIPTION="Ubuntu 16.04.4 LTS"
NAME="Ubuntu"
VERSION="16.04.4 LTS (Xenial Xerus)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 16.04.4 LTS"
VERSION_ID="16.04"
HOME_URL="http://www.ubuntu.com/"
SUPPORT_URL="http://help.ubuntu.com/"
BUG_REPORT_URL="http://bugs.launchpad.net/ubuntu/"
VERSION_CODENAME=xenial
UBUNTU_CODENAME=xenial

Using spark packaged sbt.

Other versions:

~/spark/docs$ ruby -v 
ruby 2.3.1p112 (2016-04-26) [x86_64-linux-gnu] 
~/spark/docs$ gem -v 
2.5.2.1 
~/spark/docs$ jekyll -v 
jekyll 3.7.3  
~/spark/docs$ java -version 
java version "1.8.0_112" Java(TM) SE Runtime Environment (build 1.8.0_112-b15) Java HotSpot(TM) 64-Bit Server VM (build 25.112-b15, mixed mode)

• Assignee: Marcelo Masiero Vanzin
• Reporter: Yogesh Tewari
• Created: 19/Mar/18 00:11
• Updated: 12/Dec/22 18:11
• Resolved: 12/Jun/18 01:32

Description

Scala source code link in Spark api scaladoc is broken.

Turns out instead of the relative path to the scala files the "€{FILE_PATH}.scala" expression in https://github.com/apache/spark/blob/master/project/SparkBuild.scala is generating the absolute path from the developers computer. In this case, if I try to access the source link on https://spark.apache.org/docs/latest/api/scala/index.html#org.apache.spark.Accumulable, it tries to take me to https://github.com/apache/spark/tree/v2.3.0/Users/sameera/dev/spark/core/src/main/scala/org/apache/spark/Accumulable.scala

where "/Users/sameera/dev/spark" portion of the URL is coming from the developers macos home folder.

There seems to be no change in the code responsible for generating this path during the build in /project/SparkBuild.scala :

Line # 252:

scalacOptions in Compile ++= Seq(
s"-target:jvm-${scalacJVMVersion.value}",
"-sourcepath", (baseDirectory in ThisBuild).value.getAbsolutePath // Required for relative source links in scaladoc
),

Line # 726

// Use GitHub repository for Scaladoc source links
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.
"-skip-packages", "org.apache.hadoop"
) ++ (
// 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()
}
)

 

It seems more like a developers dev environment issue.

I was successfully able to reproduce this in my dev environment. Environment details attached. 

 

Issue Links

• is duplicated by: SPARK-23946 2.3.0 and Latest ScalaDocs are linked to the wrong source code
• is duplicated by: SPARK-23737 Scala API documentation leads to nonexistent pages for sources
• is duplicated by: SPARK-23733 Broken link to java source code in Spark Scala api Scaladoc
• links to: [Github] Pull Request #21521 (vanzin)