Migrate renderer away from dokka

Author: romanowski

scala3doc/resources/dotty_res/images/dotty-logo-white.svg renamed to docs/images/dotty-logo-white.svg

@@ -27,7 +27,6 @@ import org.jetbrains.dokka.base.resolvers.shared._
 import dotty.dokka.site.NavigationCreator
 import dotty.dokka.site.SitePagesCreator
 import dotty.dokka.site.StaticSiteContext
-import dotty.dokka.site.SiteResourceManager
 import dotty.dokka.site.StaticSiteLocationProviderFactory
 
 /** Main Dokka plugin for the doctool.
@@ -62,20 +61,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
       .overrideExtension(dokkaBase.getModulesAndPackagesDocumentation)
   )
 
-  val scalaResourceInstaller = extend(
-    _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe{ case ctx @ given DokkaContext => new ScalaResourceInstaller }
-      .name("scalaResourceInstaller")
-      .after(dokkaBase.getCustomResourceInstaller)
-  )
-
-  val scalaEmbeddedResourceAppender =  extend(
-    _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromInstance(new ScalaEmbeddedResourceAppender())
-      .after(dokkaBase.getCustomResourceInstaller)
-      .name("scalaEmbeddedResourceAppender")
-  )
-
   val scalaDocumentableToPageTranslator = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getDocumentableToPageTranslator)
       .fromRecipe { case ctx @ given DokkaContext =>
@@ -90,7 +75,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val ourRenderer = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getRenderer)
-      .fromRecipe { case ctx @ given DokkaContext => new ScalaHtmlRenderer }
+      .fromRecipe { case ctx @ given DokkaContext => new DokkaScalaHtmlRenderer }
       .overrideExtension(dokkaBase.getHtmlRenderer)
   )
 
@@ -129,16 +114,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
       .overrideExtension(dokkaBase.getNavigationPageInstaller)
   )
 
-  val customDocumentationResources = extend(
-    _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-    .fromRecipe{ case c @ given DokkaContext => new SiteResourceManager }
-      .name("customDocumentationResources")
-      .after(
-        scalaEmbeddedResourceAppender.getValue,
-        customDocumentationProvider.getValue
-      )
-  )
-
   val locationProvider = extend(
     _.extensionPoint(dokkaBase.getLocationProviderFactory)
       .fromRecipe { case c @ given DokkaContext => new StaticSiteLocationProviderFactory }

scala3doc/resources/dotty_res/images/scala_logo.svg

@@ -45,7 +45,7 @@ class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTra
       JMap(),
       null,
       sourceSet.toSet,
-      PropertyContainer.Companion.empty() plus ModuleExtension(result.flatMap(flattenMember).toMap)
+      PropertyContainer.Companion.empty() plus ModuleExtension(flattenMember(topLevelPackage).toMap)
     )
 
     transformers.foldLeft(module)( (module, transformer) => transformer(module) )

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

@@ -15,6 +15,7 @@ import java.util.Collections
 import org.jetbrains.dokka.plugability._
 import kotlin.jvm.JvmClassMappingKt.getKotlinClass
 import org.jetbrains.dokka.links._
+import java.nio.file.Path
 
 val U: kotlin.Unit = kotlin.Unit.INSTANCE
 
@@ -42,6 +43,8 @@ extension (dri: DRI)
     extra = Option(dri.getExtra).fold(null)(e => raw"\[origin:(.*)\]".r.replaceAllIn(e, ""))
   )
 
+  def isStaticFile = dri.getExtra == staticFileExtra
+
   def location: String = dri.getPackageName
 
   def anchor: Option[String] = Option(dri.getClassNames).filterNot(_.isEmpty)
@@ -57,7 +60,11 @@ extension (dri: DRI)
     extra: String = dri.extra
   ) = new DRI(location, anchor.getOrElse(""), null, target, extra)
 
+val staticFileExtra = "___staticFile___"
+
 object DRI:
+  def forPath(path: Path) = apply(location = path.toString, extra = staticFileExtra)
+
   def apply(
     location: String = "",
     anchor: Option[String] = None,

scala3doc/src/dotty/dokka/ScalaModuleCreator.scala

@@ -22,6 +22,8 @@ case class StaticPageNode(
   def title(): String = template.title
   def hasFrame(): Boolean = template.hasFrame
 
+  def dri = getDri.iterator.next()
+
   override def modified(
     name: String,
     content: ContentNode,

scala3doc/src/dotty/dokka/compat.scala

@@ -28,14 +28,16 @@ class StaticSiteContext(
 
   var memberLinkResolver: String => Option[DRI] = _ => None
 
-  def indexPage(): Option[StaticPageNode] =
+  def indexTemplate(): Seq[LoadedTemplate] =
     val files = List(new File(root, "index.html"), new File(root, "index.md")).filter { _.exists() }
 
     if files.size > 1 then
       val msg = s"ERROR: Multiple root index pages found: ${files.map(_.getAbsolutePath)}"
       report.error(msg)
 
-    files.flatMap(loadTemplate(_, isBlog = false)).headOption.map(templateToPage)
+    files.flatMap(loadTemplate(_, isBlog = false)).take(1)
+
+  def indexPage(): Option[StaticPageNode] = indexTemplate().headOption.map(templateToPage)
 
   lazy val layouts: Map[String, TemplateFile] =
     val layoutRoot = new File(root, "_layouts")
@@ -49,6 +51,27 @@ class StaticSiteContext(
 
   lazy val templates: Seq[LoadedTemplate] = sideBarConfig.fold(loadAllFiles())(_.map(loadSidebarContent))
 
+  lazy val orphanedTemplates: Seq[LoadedTemplate] = {
+    def doFlatten(t: LoadedTemplate): Seq[Path] =
+      t.file.toPath +: t.children.flatMap(doFlatten)
+    val mainFiles = templates.flatMap(doFlatten)
+
+    val allPaths =
+      if !Files.exists(docsPath) then Nil
+      else Files.walk(docsPath, FileVisitOption.FOLLOW_LINKS).iterator().asScala.toList
+
+    val orphanedFiles = allPaths.filterNot { p =>
+       def name = p.getFileName.toString
+       def isMain = name == "index.html" || name == "index.md"
+       mainFiles.contains(p) || (isMain && mainFiles.contains(p.getParent))
+    }.filter { p =>
+        val name = p.getFileName.toString
+        name.endsWith(".md") || name.endsWith(".html")
+    }
+
+    orphanedFiles.flatMap(p => loadTemplate(p.toFile, isBlog = false))
+  }
+
   lazy val mainPages: Seq[StaticPageNode] = templates.map(templateToPage)
 
   val docsPath = root.toPath.resolve("docs")
@@ -168,7 +191,25 @@ class StaticSiteContext(
     pathsDri.getOrElse(memberLinkResolver(link).toList)
 
   def driFor(dest: Path): DRI =
-    DRI(location = root.toPath.relativize(dest).iterator.asScala.mkString("."))
+    val rawFilePath = root.toPath.relativize(dest)
+    val pageName = dest.getFileName.toString
+    val dotIndex = pageName.lastIndexOf('.')
+
+    val relativePath =
+      if rawFilePath.startsWith(Paths.get("blog","_posts")) then
+        val regex = raw"(\d*)-(\d*)-(\d*)-(.*)\..*".r
+        pageName.toString match
+          case regex(year, month, day, name) =>
+            rawFilePath.getParent.resolveSibling(Paths.get(year, month, day, name))
+          case _ =>
+            val msg = s"Relative path for blog: $rawFilePath doesn't match `yyy-mm-dd-name.md` format."
+            report.warn(msg, dest.toFile)
+            rawFilePath.resolveSibling(pageName.substring(0, dotIndex))
+      else
+        if (dotIndex < 0) rawFilePath.resolve("index")
+        else rawFilePath.resolveSibling(pageName.substring(0, dotIndex))
+
+    DRI.forPath(relativePath)
 
   def relativePath(myTemplate: LoadedTemplate) = root.toPath.relativize(myTemplate.file.toPath)
 

scala3doc/src/dotty/dokka/preprocessors/ScalaEmbeddedResourceApppender.scala

@@ -125,6 +125,24 @@ abstract class BaseStaticSiteProcessor(using ctx: DocContext)
 
     protected def transform(input: RootPageNode, ctx: StaticSiteContext): RootPageNode
 
+// Needed until we will migrate away from dokka
+case class FakeContentPage(
+  dri: DRI,
+  override val getContent: ContentNode) extends ContentPage:
+  override val getName: String = ""
+  override val getChildren: JList[PageNode] = JList()
+  override val getEmbeddedResources: JList[String] = JList()
+  override def getDocumentable: Documentable = null
+  override def modified(
+    name: String,
+    content: ContentNode,
+    dri: JSet[DRI],
+    embeddedResources: JList[String],
+    children: JList[_ <: PageNode]
+  ): ContentPage = this
+  override def modified(name: String, children: JList[_ <: PageNode]): PageNode = this
+  override val getDri: JSet[DRI] = JSet(dri)
+
 case class AContentPage(
   override val getName: String,
   override val getChildren: JList[PageNode],