URL in documentaion now matches files layout

Author: romanowski

scala3doc/scala3-docs/index.html

@@ -20,7 +20,7 @@
                         </a>
                     </li>
                     <li class="nav-item">
-                        <a class="nav-link" href="docs/blog/index.html">
+                        <a class="nav-link" href="blog/index.html">
                             Blog
                         </a>
                     </li>

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

@@ -168,9 +168,9 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
       .overrideExtension(dokkaBase.getLocationProvider)
   )
 
-  extension (ctx: DokkaContext):
-    def siteContext: Option[StaticSiteContext] = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].staticSiteContext
-    def args: Args = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].docConfiguration.args
+extension (ctx: DokkaContext):
+  def siteContext: Option[StaticSiteContext] = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].staticSiteContext
+  def args: Args = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].docConfiguration.args
 
 // TODO (https://github.com/lampepfl/scala3doc/issues/232): remove once problem is fixed in Dokka
 extension [T]  (builder: ExtensionBuilder[T]):

scala3doc/src/dotty/dokka/site/StaticSiteContext.scala

@@ -128,7 +128,7 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper], args:
 
     case Sidebar.Category(title, nested) =>
       // Add support for index.html/index.md files!
-      val fakeFile = new File(root, title)
+      val fakeFile = new File(new File(root, "docs"), title)
       LoadedTemplate(emptyTemplate(fakeFile, title), nested.map(loadSidebarContent), fakeFile)
 
   private def loadAllFiles() =

scala3doc/src/dotty/dokka/site/StaticSiteLocationProvider.scala

@@ -20,29 +20,40 @@ class StaticSiteLocationProvider(ctx: DokkaContext, pageNode: RootPageNode)
     private def updatePageEntry(page: PageNode, jpath: JList[String]): JList[String] =
       page match
         case page: StaticPageNode =>
-          if (page.getDri.contains(docsRootDRI)) JList("index")
-          else {
-            val path = jpath.asScala.toList
-            val start = if (path.head == "--root--") List("docs") else path.take(1)
-            // Dokka has a bug in location provider that does not properly handles relative paths for leaf nodes
-            // This forces us to not change default paths on non-leaf nodes
-            val newName = if page.getChildren.size() > 0 then path.last else
-              val pageName = page.template.file.getName
-              val dotIndex = pageName.lastIndexOf('.')
-              if (dotIndex < 0) pageName else pageName.substring(0, dotIndex)
-
-            println(s"Using $newName for ${page.template.file} orignally: $path")
-
-            (start ++ path.drop(1).dropRight(1) ++ List(newName)).asJava
+          ctx.siteContext.fold(jpath) { context =>
+            val rawFilePath = context.root.toPath.relativize(page.template.file.toPath)
+            val pageName = page.template.file.getName
+            val dotIndex = pageName.lastIndexOf('.')
+            val newPath =
+              if (dotIndex < 0) rawFilePath.resolve("index")
+              else rawFilePath.resolveSibling(pageName.substring(0, dotIndex))
+
+            newPath.iterator.asScala.map(_.toString).toList.asJava
           }
+
         case page: ContentPage if page.getDri.contains(docsDRI) =>
-           JList("docs")
+           JList("docs", "index")
         case page: ContentPage if page.getDri.contains(apiPageDRI) =>
           JList("api", "index")
         case _ if jpath.size() > 1 && jpath.get(0) ==   "--root--" && jpath.get(1) == "-a-p-i" =>
           (List("api") ++ jpath.asScala.drop(2)).asJava
+
+        case _: org.jetbrains.dokka.pages.ModulePage if ctx.siteContext.isEmpty =>
+          JList("index")
         case _ =>
           jpath
 
     override val getPathsIndex: JMap[PageNode, JList[String]] =
       super.getPathsIndex.asScala.mapValuesInPlace(updatePageEntry).asJava
+
+
+    override def pathTo(node: PageNode, context: PageNode): String =
+      val nodePaths = getPathsIndex.get(node).asScala
+      val contextPaths = Option(context).fold(Nil)(getPathsIndex.get(_).asScala.dropRight(1))
+      val commonPaths = nodePaths.zip(contextPaths).takeWhile{ case (a, b) => a == b }.size
+
+      val contextPath = contextPaths.drop(commonPaths).map(_ => "..")
+      val nodePath = nodePaths.drop(commonPaths) match
+          case l if l.isEmpty => Seq("index")
+          case l => l
+      (contextPath ++ nodePath).mkString("/")