Fix gathering index html for sections without explicit index

scala · Nov 18, 2021 · 3127fd2 · 3127fd2
1 parent 14ef614
commit 3127fd2
Showing 1 changed file with 16 additions and 9 deletions.
diff --git a/scaladoc/src/dotty/tools/scaladoc/site/StaticSiteContext.scala b/scaladoc/src/dotty/tools/scaladoc/site/StaticSiteContext.scala
@@ -100,10 +100,10 @@ class StaticSiteContext(
         val (indexes, children) = allFiles.flatMap(loadTemplate(_, isBlog)).partition(_.templateFile.isIndexPage())
 
         def loadIndexPage(): TemplateFile =
-          val indexFiles = from.listFiles { file => file.getName == "index.md" || file.getName == "index.html" }
           indexes match
-            case Nil => emptyTemplate(from, from.getName)
-            case Seq(loadedTemplate) => loadedTemplate.templateFile.copy(file = from)
+            case Nil =>
+              args.defaultTemplate.fold(emptyTemplate(from, from.getName))(layouts(_).copy(title = TemplateName.FilenameDefined(from.getName))).copy(file = File(from, "index.html"))
+            case Seq(loadedTemplate) => loadedTemplate.templateFile
             case _ =>
               // TODO (https://github.com/lampepfl/scaladoc/issues/238): provide proper error handling
               val msg = s"ERROR: Multiple index pages for $from found in ${indexes.map(_.file)}"
@@ -129,14 +129,14 @@ class StaticSiteContext(
         }
 
         val processedTemplate = // Set provided name as arg in page for `docs`
-          if from.getParentFile.toPath == docsPath && templateFile.isIndexPage() then
+          if templateFile.file.getParentFile.toPath == docsPath && templateFile.isIndexPage() then
             if templateFile.title.name != "index" then
               report.warn("Property `title` will be overridden by project name", from)
 
             templateFile.copy(title = TemplateName.FilenameDefined(args.name))
           else templateFile
 
-        Some(LoadedTemplate(processedTemplate, processedChildren.toList, from))
+        Some(LoadedTemplate(processedTemplate, processedChildren.toList, processedTemplate.file))
       catch
           case e: RuntimeException =>
             // TODO (https://github.com/lampepfl/scaladoc/issues/238): provide proper error handling
@@ -150,8 +150,8 @@ class StaticSiteContext(
         if Files.exists(root.toPath.resolve(pagePath)) then pagePath
         else pagePath.stripSuffix(".html") + ".md"
 
-      val file = root.toPath.resolve(path).toFile
-      val LoadedTemplate(template, children, _) = loadTemplate(file, isBlog).get // Add proper logging if file does not exisits
+      // val file = root.toPath.resolve(path).toFile
+      val LoadedTemplate(template, children, file) = loadTemplate(root.toPath.resolve(path).toFile, isBlog).get // Add proper logging if file does not exisits
       optionTitle match
         case Some(title) =>
           val newTitle = template.title match
@@ -170,10 +170,17 @@ class StaticSiteContext(
           val title = optionTitle match
             case Some(t) => t
             case None => "index"
-          val fakeFile = Paths.get(root.toString, "docs", title, "index.html").toFile
+          val sidebarContent = nested.map(loadSidebarContent)
+          // Heuristic to add section index.html around its child pages. Otherwise we put it in directory named after title of section in top-level
+          val fakeFile = sidebarContent.collectFirst {
+            case t if t.file.getName.reverse.dropWhile(_ != '.').reverse != "index" =>
+              t.file.toPath.resolveSibling("index.html").toFile
+          }.flatMap(f => if f.exists then None else Some(f)).getOrElse(
+            Paths.get(root.toString, "docs", title.toLowerCase, "index.html").toFile
+          )
           LoadedTemplate(
             args.defaultTemplate.fold(emptyTemplate(fakeFile, title))(layouts(_).copy(title = TemplateName.FilenameDefined(title))),
-            nested.map(loadSidebarContent),
+            sidebarContent,
             fakeFile
           )