Apply requested changes to scaladoc

Author: BarkingBad

docs/_layouts/main.html

@@ -2,6 +2,11 @@
 layout: base
 ---
 <div id="content-wrapper">
+  {% if page.movedTo %}
+  <aside class="warning">
+    The content of this page is outdated. Click <a href="{{ page.movedTo }}">here</a> to find the up to date version of this page.
+  </aside>
+  {% endif %}
   {{ content }}
 </div>
 <script>

project/Build.scala

@@ -1295,6 +1295,7 @@ object Build {
         name,
         scalaSrcLink(stdLibVersion, srcManaged(dottyNonBootstrappedVersion, "scala") + "="),
         dottySrcLink(referenceVersion, srcManaged(dottyNonBootstrappedVersion, "dotty") + "=", "#library/src"),
+        dottySrcLink(referenceVersion, "docs-for-dotty-page=", "#docs"),
         dottySrcLink(referenceVersion),
         "-Ygenerate-inkuire",
       ) ++ scalacOptionsDocSettings(includeExternalMappings) ++ revision ++ params ++ targets

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

@@ -139,7 +139,8 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
     StringSetting(
       "-default-template",
       "default template used by static site",
-      "The static site is generating empty files for indexes that haven't been provided explicitly. User can specify what template should be used for such generic indexes (note it can still interpolate some general settings)",
+      "The static site is generating empty files for indexes that haven't been provided explicitly in a sidebar/missing index.html in directory. " +
+        "User can specify what default template should be used for such indexes. It can be useful for providing generic templates that interpolate some common settings, like title, or can have some custom html embedded.",
       ""
     )
 

scaladoc/src/dotty/tools/scaladoc/renderers/Renderer.scala

@@ -3,6 +3,7 @@ package renderers
 
 import util.HTML._
 import collection.JavaConverters._
+import collection.mutable.ListBuffer
 import java.net.URI
 import java.net.URL
 import dotty.tools.scaladoc.site._
@@ -55,7 +56,7 @@ abstract class Renderer(rootPackage: Member, val members: Map[DRI, Member], prot
         val allTemplates: Seq[Option[LoadedTemplate]] = None +: templates.flatMap(flattenedTemplates).map(Some(_)) :+ None
 
         // Let's gather the list of maps for each template with its in-order neighbours
-        val newSettings: Seq[Map[String, Object]] = allTemplates.sliding(size = 3, step = 1).map {
+        val newSettings: List[Map[String, Object]] = allTemplates.sliding(size = 3, step = 1).map {
           case None :: None :: Nil =>
             Map.empty
           case prev :: mid :: next :: Nil =>
@@ -67,30 +68,22 @@ abstract class Renderer(rootPackage: Member, val members: Map[DRI, Member], prot
                 realMidPath.relativize(realSiblingPath).toString.stripPrefix("../")
               }
             List(link(prev).map("previous" -> _), link(next).map("next" -> _)).flatten.toMap
-        }.toSeq
-
-        // We update the immutable tree of templates by walking in-order
-        def updateSettings(template: LoadedTemplate, additionalSettings: Seq[Map[String, Object]]): (LoadedTemplate, Seq[Map[String, Object]]) =
-          val head :: tail = additionalSettings
-          val (newChildren, newAdditionalSettings): (List[LoadedTemplate], List[Seq[Map[String, Object]]]) = template.children.scanLeft((null: LoadedTemplate, tail: Seq[Map[String, Object]])) { case ((_, aS), template) =>
-            updateSettings(template, aS)
-          }.unzip
-          val newLoadedTemplate = template.copy(
-            templateFile = template.templateFile.copy(settings = template.templateFile.settings.updated("page", head ++ template.templateFile.settings.getOrElse("page", Map.empty).asInstanceOf[Map[String, Object]])),
-            children = newChildren.drop(1) // We drop trailing null from the first `scanLeft` output collection
-          )
-
-          (newLoadedTemplate, newAdditionalSettings.last)
-        end updateSettings
-
-        // We run the above function for the templates. We could do some temporary parent template so it would be just `updatedSettings(...)` but we would eventually post-process it so it has no difference
-        val (newTemplates, _): (List[LoadedTemplate], List[Seq[Map[String, Object]]]) = templates.scanLeft((null: LoadedTemplate, newSettings)) {
-          case ((_, aS), template) =>
-            updateSettings(template, aS)
-        }.unzip
-
-        // We finally obtain updated template pages. Once again we drop first null from `scanLeft` and map it using `templateToPage`
-        val templatePages = newTemplates.drop(1).map(templateToPage(_, siteContext))
+        }.toList
+
+        def updateSettings(templates: Seq[LoadedTemplate], additionalSettings: ListBuffer[Map[String, Object]]): List[LoadedTemplate] =
+          val updatedTemplates = List.newBuilder[LoadedTemplate]
+          for template <- templates do
+            val head: Map[String, Object] = additionalSettings.remove(0)
+            val current: Map[String, Object] = template.templateFile.settings.getOrElse("page", Map.empty).asInstanceOf[Map[String, Object]]
+            val updatedTemplateFile = template.templateFile.copy(settings = template.templateFile.settings.updated("page", head ++ current))
+            updatedTemplates += template.copy(
+              templateFile = updatedTemplateFile,
+              children = updateSettings(template.children, additionalSettings)
+            )
+          updatedTemplates.result()
+
+        val newTemplates = updateSettings(templates, newSettings.to(ListBuffer))
+        val templatePages = newTemplates.map(templateToPage(_, siteContext))
 
         indexes.headOption match
           case None if templatePages.isEmpty=>

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

@@ -46,7 +46,7 @@ case class LoadedTemplate(
       // 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" -> _.replace("docs-for-dotty-page/", "docs/"))
+        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) +