Merge pull request #12819 from romanowski/scaladoc/fix-sourcelinks

Search for name in range of lines and add flexible sourcelinks

Author: romanowski

docs/blog/index.html

@@ -9,7 +9,7 @@ <h1>{{ page.title }}</h1>
         {% for post in site.posts %}
             <li>
                 <h2>
-                    <a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a>
+                    <a href="{{ post.url }}">{{ post.title }}</a>
                 </h2>
                 <div class="byline">
                     <time class="date">

project/Build.scala

@@ -1244,7 +1244,12 @@ object Build {
       // TODO add versions etc.
       def srcManaged(v: String, s: String) = s"out/bootstrap/stdlib-bootstrapped/scala-$v/src_managed/main/$s-library-src"
       def scalaSrcLink(v: String, s: String) = s"-source-links:$s=github://scala/scala/v$v#src/library"
-      def dottySrcLink(v: String, s: String) = s"-source-links:$s=github://lampepfl/dotty/$v#library/src"
+      def dottySrcLink(v: String, s: String) =
+        sys.env.get("GITHUB_SHA") match {
+          case Some(sha) =>
+            s"-source-links:$s=github://${sys.env("GITHUB_REPOSITORY")}/$sha#library/src"
+          case None => s"-source-links:$s=github://lampepfl/dotty/$v#library/src"
+        }
 
       val revision = Seq("-revision", ref, "-project-version", projectVersion)
       val cmd = Seq(

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

@@ -148,13 +148,16 @@ class StaticSiteContext(
         if link.startsWith("/") then root.toPath.resolve(link.drop(1))
         else template.file.toPath.getParent().resolve(link).normalize()
 
-      baseFile.getFileName.toString.split("\\.").headOption.toSeq.flatMap { baseFileName =>
-        Seq(
-          Some(baseFile.resolveSibling(baseFileName + ".html")),
-          Some(baseFile.resolveSibling(baseFileName + ".md")),
-          Option.when(baseFileName == "index")(baseFile.getParent)
-        ).flatten.filter(Files.exists(_)).map(driFor)
-      }
+      val fileName = baseFile.getFileName.toString
+      val baseFileName = if fileName.endsWith(".md")
+          then fileName.stripSuffix(".md")
+          else fileName.stripSuffix(".html")
+
+      Seq(
+        Some(baseFile.resolveSibling(baseFileName + ".html")),
+        Some(baseFile.resolveSibling(baseFileName + ".md")),
+        Option.when(baseFileName == "index")(baseFile.getParent)
+      ).flatten.filter(Files.exists(_)).map(driFor)
     }.toOption.filter(_.nonEmpty)
     pathsDri.getOrElse(memberLinkResolver(link).toList)
 

scaladoc/test-documentations/static-links/docs/Adoc.md

@@ -0,0 +1,14 @@
+---
+title: Adoc
+---
+# Header in Adoc
+
+[A link to](dir/html.md)
+[A link to](dir/name...with..dots..md)
+[A link to](dir/name.with.md.and.html.md)
+[A link to](dir/nested.md)
+[A link to](dir/nested.svg)
+
+
+
+And a text!

scaladoc/test-documentations/static-links/docs/dir/html.md

@@ -0,0 +1,5 @@
+---
+title: html named file
+---
+
+And a text!

scaladoc/test-documentations/static-links/docs/dir/index.md

@@ -0,0 +1,6 @@
+---
+title: A directory
+---
+# {{  page.title }}
+
+And a text!

scaladoc/test-documentations/static-links/docs/dir/name...with..dots..md

@@ -0,0 +1,5 @@
+---
+title: Strange name multipke dots in nane
+---
+
+And a text!

scaladoc/test-documentations/static-links/docs/dir/name.with.md.and.html.md

@@ -0,0 +1,5 @@
+---
+title: name.with.md.and.html
+---
+
+And a text!

scaladoc/test-documentations/static-links/docs/dir/nested.md

@@ -0,0 +1,6 @@
+---
+title: Nested in a directory
+---
+# {{  page.title }}
+
+And a text!