Fix publishing nightly docs do BarkingBad fork.

Author: BarkingBad

.github/workflows/ci.yaml

@@ -514,7 +514,7 @@ jobs:
         with:
           personal_token: ${{ DOCS_SCALALANG_BOT_TOKEN }}
           publish_dir: docsScalaLang
-          external_repository: scala/docs.scala-lang
+          external_repository: BarkingBad/docs.scala-lang
           publish_branch: dev
 
   publish_release:

project/scripts/genDocsScalaLang

@@ -18,8 +18,22 @@ git clone "https://github.com/scala/docs.scala-lang.git" $DOCS_SCALA_LANG_DIR
 
 SBT="$SCRIPT_DIR/sbt"
 mkdir -pv $SITE_OUT_DIR
+
 env "scaladoc.projectFormat=md" "$SBT" "scaladoc/renderScaladocScalajsToFile $DOCS_SCALA_LANG_DIR/scripts/scaladoc-scalajs.js $DOCS_SCALA_LANG_DIR/resources/css code-snippets.css"
-"bin/scaladoc" "-d" "$SITE_OUT_DIR" "-format" "md" "-siteroot" "docs" "/dev/null"
+
+DOTTY_NONBOOTSTRAPPED_VERSION_COMMAND="$SBT \"eval println(Build.dottyNonBootstrappedVersion)\""
+DOTTY_NONBOOTSTRAPPED_VERSION=$(eval $DOTTY_NONBOOTSTRAPPED_VERSION_COMMAND | tail -n 2 | head -n 1)
+
+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"
+
+"bin/scaladoc" "-d" "$SITE_OUT_DIR" "-format" "md" "-siteroot" "docs" "/dev/null " \
+  -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}" \
 
 if [ ! -d "$SITE_OUT_DIR" ]; then
   echo "Output directory did not exist: $SITE_OUT_DIR" 1>&2

scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala

@@ -128,7 +128,7 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
 
   val scastieConfiguration: Setting[String] =
     StringSetting("-scastie-configuration", "Scastie configuration", "Additional configuration passed to Scastie in code snippets", "")
-    
+
   val projectFormat: Setting[String] =
     ChoiceSetting(
       "-format",

scaladoc/src/dotty/tools/scaladoc/site/FrontMatterRenderer.scala

@@ -14,7 +14,11 @@ object FrontMatterRenderer:
 
     val rows = renderProperties(properties) ++ renderProperties(properties("page").asInstanceOf[Map[String, Object]])
 
-    rows.mkString("---\n", "\n", "\n---") + "\n\n<!-- THIS FILE HAS BEEN GENERATED BY SCALADOC PREPROCESSOR. " +
-      "NOTE THAT ANY CHANGES TO THIS FILE CAN BE OVERRIDEN IN THE FUTURE -->\n\n"
+    rows.mkString("---\n", "\n", "\n---") + "\n\n<!-- THIS FILE HAS BEEN GENERATED BY SCALADOC PREPROCESSOR.\n" +
+      "    The whole process of generation the docs can be found under this README: https://github.com/lampepfl/dotty/blob/master/docs/README.md\n" +
+     s"    The source file can be found here ${properties.get("urls").flatMap(_.asInstanceOf[Map[String, Object]].get("editSource")).getOrElse("")}\n" +
+      "    NOTE THAT ANY CHANGES TO THIS FILE WILL BE OVERRIDEN BY PREPROCESSOR.\n" +
+      "-->\n\n"
+
 
 

scaladoc/src/dotty/tools/scaladoc/site/LoadedTemplate.scala

@@ -40,15 +40,9 @@ case class LoadedTemplate(
   def resolveToHtml(ctx: StaticSiteContext): ResolvedPage =
     val posts = children.map(_.lazyTemplateProperties(ctx))
     def getMap(key: String) = templateFile.settings.getOrElse(key, Map.empty).asInstanceOf[Map[String, Object]]
-    val sourceLinks = if !file.exists() then Nil else
-      // TODO (https://github.com/lampepfl/scala3doc/issues/240): configure source root
-      // toRealPath is used to turn symlinks into proper paths
-      val actualPath = Paths.get("").toAbsolutePath.relativize(file.toPath.toRealPath())
-      ctx.sourceLinks.pathTo(actualPath).map("viewSource" -> _ ) ++
-        ctx.sourceLinks.pathTo(actualPath, operation = "edit", optionalRevision = Some("master")).map("editSource" -> _ )
 
     val updatedSettings = templateFile.settings ++ ctx.projectWideProperties +
-      ("site" -> (getMap("site") + ("posts" -> posts))) + ("urls" -> sourceLinks.toMap) +
+      ("site" -> (getMap("site") + ("posts" -> posts))) +
       ("page" -> (getMap("page") + ("title" -> templateFile.title.name)))
 
     templateFile.resolveInner(RenderingContext(updatedSettings, ctx.layouts))(using ctx)

scaladoc/src/dotty/tools/scaladoc/site/templates.scala

@@ -114,7 +114,15 @@ case class TemplateFile(
     val rendered = ssctx.args.projectFormat match
         case "html" => Template.parse(this.rawCode).`with`(tag).render(mutableProperties)
         case "md" => this.rawCode
-        
+
+    val sourceLinks = if !file.exists() then Nil else
+      // TODO (https://github.com/lampepfl/scala3doc/issues/240): configure source root
+      // toRealPath is used to turn symlinks into proper paths
+      val actualPath = Paths.get("").toAbsolutePath.relativize(file.toPath.toRealPath())
+      ssctx.sourceLinks.pathTo(actualPath).map("viewSource" -> _ ) ++
+        // List("editSource" -> ssctx.sourceLinks.pathTo(actualPath))
+        ssctx.sourceLinks.pathTo(actualPath, operation = "edit", optionalRevision = Some("master")).map("editSource" -> _ )
+
     // We want to render markdown only if next template is html
     val code = if (isHtml || layoutTemplate.exists(!_.isHtml)) rendered else
       // Snippet compiler currently supports markdown only
@@ -125,7 +133,8 @@ case class TemplateFile(
       ssctx.args.projectFormat match
         case "html" => HtmlRenderer.builder(defaultMarkdownOptions).build().render(processed)
         case "md" =>
-          FrontMatterRenderer.render(settings) +
+
+          FrontMatterRenderer.render(settings + ("urls" -> sourceLinks.toMap)) +
           Formatter.builder(defaultMarkdownOptions).build().render(processed)