Fix building documentation source versions

Author: szymon-rd

project/Build.scala

@@ -1319,6 +1319,7 @@ object Build {
  val generateSelfDocumentation = taskKey[Unit]("Generate example documentation")
  // Note: the two tasks below should be one, but a bug in Tasty prevents that
  val generateScalaDocumentation = inputKey[Unit]("Generate documentation for dotty lib")
+ val generateStableScala3Documentation = inputKey[Unit]("Generate documentation for stable dotty lib")
  val generateTestcasesDocumentation = taskKey[Unit]("Generate documentation for testcases, usefull for debugging tests")
 
  val generateReferenceDocumentation = inputKey[Unit]("Generate language reference documentation for Scala 3")
@@ -1462,6 +1463,12 @@ object Build {
  writeAdditionalFiles.dependsOn(generateDocumentation(config))
  }.evaluated,
 
+ generateStableScala3Documentation := Def.inputTaskDyn {
+ val extraArgs = spaceDelimited("<version>").parsed
+ val config = stableScala3(extraArgs.head)
+ generateDocumentation(config)
+ }.evaluated,
+
  generateTestcasesDocumentation := Def.taskDyn {
  generateDocumentation(Testcases)
  }.value,
@@ -1857,22 +1864,22 @@ object ScaladocConfigs {
  case None => s"${sourcesPrefix}github://lampepfl/dotty/$v$outputPrefix"
  }
 
- lazy val DefaultGenerationConfig = Def.task {
- def distLocation = (dist / pack).value
- def projectVersion = version.value
+ def defaultSourceLinks(version: String = dottyNonBootstrappedVersion, refVersion: String = dottyVersion) = Def.task {
  def stdLibVersion = stdlibVersion(NonBootstrapped)
- def scalaLib = findArtifactPath(externalCompilerClasspathTask.value, "scala-library")
- def dottyLib = (`scala3-library` / Compile / classDirectory).value
  def srcManaged(v: String, s: String) = s"out/bootstrap/stdlib-bootstrapped/scala-$v/src_managed/main/$s-library-src"
-
- def defaultSourceLinks: SourceLinks = SourceLinks(
+ SourceLinks(
  List(
- scalaSrcLink(stdLibVersion, srcManaged(dottyNonBootstrappedVersion, "scala") + "="),
- dottySrcLink(referenceVersion, srcManaged(dottyNonBootstrappedVersion, "dotty") + "=", "#library/src"),
- dottySrcLink(referenceVersion),
+ scalaSrcLink(stdLibVersion, srcManaged(version, "scala") + "="),
+ dottySrcLink(refVersion, srcManaged(version, "dotty") + "=", "#library/src"),
+ dottySrcLink(refVersion),
  "docs=github://lampepfl/dotty/main#docs"
  )
  )
+ }
+
+ lazy val DefaultGenerationConfig = Def.task {
+ def distLocation = (dist / pack).value
+ def projectVersion = version.value
  def socialLinks = SocialLinks(List(
  "github::https://github.com/lampepfl/dotty",
  "discord::https://discord.com/invite/scala",
@@ -1890,7 +1897,7 @@ object ScaladocConfigs {
  List(),
  ProjectVersion(projectVersion),
  GenerateInkuire(true),
- defaultSourceLinks,
+ defaultSourceLinks().value,
  skipByRegex,
  skipById,
  projectLogo,
@@ -1981,4 +1988,31 @@ object ScaladocConfigs {
  .add(ApiSubdirectory(true))
  .withTargets(roots)
  }
+
+ def stableScala3(version: String) = Def.task {
+ Scala3.value
+ .add(defaultSourceLinks(version + "-bin-SNAPSHOT-nonbootstrapped", version).value)
+ .add(ProjectVersion(version))
+ .add(SnippetCompiler(
+ List(
+ s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/src_managed/main/dotty-library-src/scala/quoted=compile",
+ s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/src_managed/main/dotty-library-src/scala/compiletime=compile"
+ )
+ ))
+ .add(CommentSyntax(List(
+ s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/src_managed/main/dotty-library-src=markdown",
+ s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/src_managed/main/scala-library-src=wiki",
+ "wiki"
+ )))
+ .add(DocRootContent(s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/src_managed/main/scala-library-src/rootdoc.txt"))
+ .withTargets(
+ Seq(
+ s"out/bootstrap/stdlib-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/classes",
+ s"tmp/interfaces/target/classes",
+ s"out/bootstrap/tasty-core-bootstrapped/scala-$version-bin-SNAPSHOT-nonbootstrapped/classes"
+ )
+ )
+ .remove[SiteRoot]
+ .remove[ApiSubdirectory]
+ }
 }

project/scripts/cmdScaladocTests

@@ -16,16 +16,16 @@ DOTTY_NONBOOTSTRAPPED_VERSION=$(eval $DOTTY_NONBOOTSTRAPPED_VERSION_COMMAND | ta
 DOTTY_BOOTSTRAPPED_VERSION_COMMAND="$SBT \"eval println(Build.dottyVersion)\""
 DOTTY_BOOTSTRAPPED_VERSION=$(eval $DOTTY_BOOTSTRAPPED_VERSION_COMMAND | tail -n 2 | head -n 1)
 
-GITHUB_REPOSITORY="lampepfl/dotty"
-GITHUB_SHA="3.0.0"
+SOURCE_LINKS_REPOSITORY="lampepfl/dotty"
+SOURCE_LINKS_VERSION="$DOTTY_BOOTSTRAPPED_VERSION"
 
 "$SBT" "scaladoc/generateTestcasesDocumentation" > "$tmp" 2>&1 || echo "generated testcases project with sbt"
 dist/target/pack/bin/scaladoc \
  -d "$OUT1" \
  -project "scaladoc testcases" \
  -source-links:out/bootstrap/stdlib-bootstrapped/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/src_managed/main/scala-library-src=github://scala/scala/v"${STDLIB_VERSION}"#src/library \
- -source-links:out/bootstrap/stdlib-bootstrapped/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/src_managed/main/dotty-library-src=github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}"\#library/src \
- -source-links:github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}" \
+ -source-links:out/bootstrap/stdlib-bootstrapped/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/src_managed/main/dotty-library-src=github://"${SOURCE_LINKS_REPOSITORY}"/"${SOURCE_LINKS_VERSION}"\#library/src \
+ -source-links:github://"${SOURCE_LINKS_REPOSITORY}"/"${SOURCE_LINKS_VERSION}" \
  "-external-mappings:.*scala/.*::scaladoc3::https://dotty.epfl.ch/api/,.*java/.*::javadoc::https://docs.oracle.com/javase/8/docs/api/" \
  "-skip-by-regex:.+\.internal($|\..+)" \
  "-skip-by-regex:.+\.impl($|\..+)" \
@@ -40,6 +40,6 @@ dist/target/pack/bin/scaladoc \
  -project-footer "Copyright (c) 2002-2022, LAMP/EPFL" \
  -default-template static-site-main \
  -author -groups -revision main -project-version "${DOTTY_BOOTSTRAPPED_VERSION}" \
- "-quick-links:Learn::https://docs.scala-lang.org/,Install::https://www.scala-lang.org/download/,Playground::https://scastie.scala-lang.org,Find A Library::https://index.scala-lang.org,Community::https://www.scala-lang.org/community/,Blog::https://www.scala-lang.org/blog/" \
+ "-quick-links:Learn::https://docs.scala-lang.org/,Install::https://www.scala-lang.org/download/,Playground::https://scastie.scala-lang.org,Find A Library::https://index.scala-lang.org,Community::https://www.scala-lang.org/community/," \
  out/bootstrap/scaladoc-testcases/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/classes > "$tmp" 2>&1 || echo "generated testcases project with scripts"
 diff -rq "$OUT1" "scaladoc/output/testcases"