Skip to content

Commit

Permalink
Fix Dokka links to Spring Framework and Servlet APIs
Browse files Browse the repository at this point in the history
This commit fixes links from Spring Framework's Dokka HTML to Javadoc
for Spring Framework and Servlet APIs by explicitly configuring the
`element-list` page as the `package-list` in the Dokka Gradle plugin.

Closes spring-projectsgh-32797
  • Loading branch information
sbrannen committed May 12, 2024
1 parent c1229b0 commit 7536980
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions gradle/docs-dokka.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ tasks.findByName("dokkaHtmlPartial")?.configure {
classpath.from(sourceSets["main"].runtimeClasspath)
externalDocumentationLink {
url.set(new URL("https://docs.spring.io/spring-framework/docs/current/javadoc-api/"))
packageListUrl.set(new URL("https://docs.spring.io/spring-framework/docs/current/javadoc-api/element-list"))
}
externalDocumentationLink {
url.set(new URL("https://projectreactor.io/docs/core/release/api/"))
Expand All @@ -21,6 +22,7 @@ tasks.findByName("dokkaHtmlPartial")?.configure {
}
externalDocumentationLink {
url.set(new URL("https://javadoc.io/doc/jakarta.servlet/jakarta.servlet-api/latest/"))
packageListUrl.set(new URL("https://javadoc.io/doc/jakarta.servlet/jakarta.servlet-api/latest/element-list"))
}
externalDocumentationLink {
url.set(new URL("https://javadoc.io/static/io.rsocket/rsocket-core/1.1.1/"))
Expand Down

0 comments on commit 7536980

Please sign in to comment.