Skip to content

Commit 8b3e8a7

Browse files
committed
Fix breadcrumbs and add tests
1 parent 807d258 commit 8b3e8a7

File tree

5 files changed

+13
-8
lines changed

5 files changed

+13
-8
lines changed

scala3doc-testcases/src/tests/docString.scala

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ package wikilinks:
3131

3232
/**
3333
* [[tests.commonlinks.SomeOtherPackage!method]]
34-
* [[tests.commonlinks.SomeOtherPackage#]]
3534
* [[tests.commonlinks.SomeOtherEnum!A]]
3635
* @syntax wiki
3736
*/
@@ -66,7 +65,6 @@ package mdlinks:
6665

6766
/**
6867
* [[tests.commonlinks.SomeOtherPackage!method]]
69-
* [[tests.commonlinks.SomeOtherPackage#]]
7068
* [[tests.commonlinks.SomeOtherEnum!A]]
7169
* @syntax wiki
7270
*/

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ class StaticSiteContext(
3838
if (!Files.exists(sidebarFile)) None
3939
else Some(Sidebar.load(Files.readAllLines(sidebarFile).asScala.mkString("\n")))
4040

41-
lazy val templates: Seq[LoadedTemplate] = sideBarConfig.fold(loadAllFiles())(_.map(loadSidebarContent))
41+
lazy val templates: Seq[LoadedTemplate] =
42+
sideBarConfig.fold(loadAllFiles().sortBy(_.templateFile.title))(_.map(loadSidebarContent))
4243

4344
lazy val orphanedTemplates: Seq[LoadedTemplate] = {
4445
def doFlatten(t: LoadedTemplate): Seq[Path] =
@@ -88,7 +89,7 @@ class StaticSiteContext(
8889

8990
val templateFile = if (from.isDirectory) loadIndexPage() else loadTemplateFile(from)
9091

91-
val processedChildren = if !isBlog then children else
92+
val processedChildren = if !isBlog then children.sortBy(_.templateFile.title) else
9293
def dateFrom(p: LoadedTemplate): String =
9394
val pageSettings = p.templateFile.settings.get("page").collect{ case m: Map[String @unchecked, _] => m }
9495
pageSettings.flatMap(_.get("date").collect{ case s: String => s}).getOrElse("1900-01-01") // blogs without date are last
@@ -128,7 +129,7 @@ class StaticSiteContext(
128129
private def loadAllFiles() =
129130
def dir(name: String)= List(new File(root, name)).filter(_.isDirectory)
130131
dir("docs").flatMap(_.listFiles()).flatMap(loadTemplate(_, isBlog = false))
131-
++ dir("blog").flatMap(loadTemplate(_, isBlog = true)).sortBy(_.templateFile.title)
132+
++ dir("blog").flatMap(loadTemplate(_, isBlog = true))
132133

133134
def driForLink(template: TemplateFile, link: String): Seq[DRI] =
134135
val pathsDri: Option[Seq[DRI]] = Try {

scala3doc/src/dotty/renderers/HtmlRenderer.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
163163

164164
val parentsHtml =
165165
val innerTags = parents.flatMap[TagArg](b => Seq(
166-
a(href := pathToPage(b.dri, link.dri))(b.name),
166+
a(href := pathToPage(link.dri, b.dri))(b.name),
167167
"/"
168168
)).dropRight(1)
169169
div(cls := "breadcrumbs")(innerTags:_*)

scala3doc/test/dotty/dokka/site/NavitationTest.scala renamed to scala3doc/test/dotty/dokka/site/NavigationTest.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package site
33

44
import org.junit.Test
55

6-
class NavitationTest extends BaseHtmlTest:
6+
class NavigationTest extends BaseHtmlTest:
77

88
case class NavMenuTestEntry( name: String, link: String, nested: Seq[NavMenuTestEntry])
99

@@ -25,10 +25,10 @@ class NavitationTest extends BaseHtmlTest:
2525
@Test
2626
def testBasicNavigation() = withGeneratedSite(testDocPath.resolve("basic")){
2727
val topLevelNav = NavMenuTestEntry(projectName, "index.html", Seq(
28-
NavMenuTestEntry("Adoc", "Adoc.html", Seq()),
2928
NavMenuTestEntry("A directory", "dir/index.html", Seq(
3029
NavMenuTestEntry("Nested in a directory", "dir/nested.html", Nil)
3130
)),
31+
NavMenuTestEntry("Adoc", "Adoc.html", Seq()),
3232
NavMenuTestEntry("Basic test", "../index.html", Seq()),
3333
NavMenuTestEntry("API", "../api/index.html", Seq(
3434
NavMenuTestEntry("tests.site", "../api/tests/site.html", Seq(

scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ class SiteGeneratationTest extends BaseHtmlTest:
7272
withHtmlFile("docs/Adoc.html"){ content =>
7373
content.assertAttr("p a","href", "../api/tests/site/SomeClass.html")
7474
}
75+
76+
withHtmlFile("api/tests/site/SomeClass.html"){ content =>
77+
content.assertAttr(".breadcrumbs a","href",
78+
"../../../docs/index.html", "../../index.html", "../site.html", "SomeClass.html"
79+
)
80+
}
7581
}
7682

7783
@Test

0 commit comments

Comments
 (0)