Merge pull request scala#11575 from romanowski/scaladoc/add-index-page

Add top level index page
wi101 · Mar 11, 2021 · cc87d06 · cc87d06
2 parents 45d0678 + 9660a70
commit cc87d06
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala b/scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala
@@ -57,7 +57,14 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
             templateToPage(indexPage, siteContext).withNewChildren(newChildren)
 
   val hiddenPages: Seq[Page] =
-    staticSite.toSeq.flatMap(c => c.orphanedTemplates.map(templateToPage(_, c)))
+    staticSite match
+      case None =>
+        Seq(navigablePage.copy( // Add index page that is a copy of api/index.html
+          link = navigablePage.link.copy(dri = docsRootDRI),
+          children = Nil
+        ))
+      case Some(site) =>
+        site.orphanedTemplates.map(templateToPage(_, site))
 
   val allPages = navigablePage +: hiddenPages
 
@@ -139,10 +146,10 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
       case _ => Nil
     }
 
-    def renderNested(nav: Page): (Boolean, AppliedTag) =
+    def renderNested(nav: Page, toplevel: Boolean = false): (Boolean, AppliedTag) =
       val isSelected = nav.link.dri == pageLink.dri
       def linkHtml(exapnded: Boolean = false) =
-        val attrs = if (isSelected) Seq(cls := "selected expanded") else Nil
+        val attrs = if (isSelected || toplevel) Seq(cls := "selected expanded") else Nil
         val icon = nav.content match {
           case m: Member => navigationIcon(m)
           case _ => Nil
@@ -152,15 +159,16 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
       nav.children match
         case Nil => isSelected -> div(linkHtml())
         case children =>
-          val nested = children.map(renderNested)
+          val nested = children.map(renderNested(_))
           val expanded = nested.exists(_._1) || nav.link == pageLink
-          val attr = if expanded || isSelected then Seq(cls := "expanded") else Nil
+          val attr =
+            if expanded || isSelected || toplevel then Seq(cls := "expanded") else Nil
           (isSelected || expanded) -> div(attr)(
             linkHtml(expanded),
             span(cls := "ar"),
             nested.map(_._2)
           )
-    renderNested(navigablePage)._2
+    renderNested(navigablePage, toplevel = true)._2
 
   private def hasSocialLinks = !args.socialLinks.isEmpty
 

diff --git a/scaladoc/src/dotty/tools/scaladoc/renderers/Locations.scala b/scaladoc/src/dotty/tools/scaladoc/renderers/Locations.scala
@@ -34,7 +34,7 @@ trait Locations(using ctx: DocContext):
           case dri =>
             val loc = dri.location
             val fqn = loc.split(Array('.')).toList match
-              case "<empty>" :: Nil  => "index"   :: Nil
+              case "<empty>" :: Nil  => "_empty_"   :: Nil
               case "<empty>" :: tail => "_empty_" :: tail
               case other => other