Include Kotlin API documentation in the documentation site

Closes gh-40692
This commit is contained in:
Andy Wilkinson
2024-05-10 14:53:48 +01:00
parent 772e4ca78d
commit 53e1c7ed7d
9 changed files with 42 additions and 6 deletions

View File

@@ -54,6 +54,9 @@ dependencies {
configurationProperties(project(path: ":spring-boot-project:spring-boot-test-autoconfigure", configuration: "configurationPropertiesMetadata"))
configurationProperties(project(path: ":spring-boot-project:spring-boot-testcontainers", configuration: "configurationPropertiesMetadata"))
dokkatoo(project(path: ":spring-boot-project:spring-boot"))
dokkatoo(project(path: ":spring-boot-project:spring-boot-test"))
implementation(project(path: ":spring-boot-project:spring-boot-actuator"))
implementation(project(path: ":spring-boot-project:spring-boot-actuator-autoconfigure"))
implementation(project(path: ":spring-boot-project:spring-boot-autoconfigure"))
@@ -183,6 +186,10 @@ dependencies {
testSlices(project(path: ":spring-boot-project:spring-boot-test-autoconfigure", configuration: "testSliceMetadata"))
}
dokkatoo {
moduleName.set("Spring Boot Kotlin API")
}
task aggregatedJavadoc(type: Javadoc) {
dependsOn dependencyVersions
project.rootProject.gradle.projectsEvaluated {
@@ -344,6 +351,9 @@ def antoraApiCatalogContent = tasks.register("antoraApiCatalogContent", Zip) {
from(aggregatedJavadoc) {
into "java"
}
from(tasks.named("dokkatooGeneratePublicationHtml")) {
into "kotlin"
}
}
def copyAntoraContentDependencies = tasks.register("copyAntoraContentDependencies", Copy) {
@@ -366,6 +376,12 @@ gradle.projectsEvaluated {
}
}
dokkatoo {
dokkatooPublications.configureEach {
includes.from("src/docs/dokkatoo/dokka-overview.md")
}
}
publishing {
publications {
getByName("maven") {

View File

@@ -28,3 +28,5 @@ ext:
attributes: { external: true}
- path: [ "Java APIs", "Gradle Plugin" ]
attributes: { external: true }
- path: [ "Kotlin APIs", "Spring Boot" ]
attributes: { external: true }

View File

@@ -0,0 +1,2 @@
* Kotlin APIs
** xref:api:kotlin/index.html[Spring Boot]

View File

@@ -6,5 +6,6 @@ include::build-tool-plugin:partial$nav-build-tool-plugin.adoc[]
include::cli:partial$nav-cli.adoc[]
include::api:partial$nav-rest-api.adoc[]
include::api:partial$nav-java-api.adoc[]
include::api:partial$nav-kotlin-api.adoc[]
include::specification:partial$nav-specification.adoc[]
include::appendix:partial$nav-appendix.adoc[]

View File

@@ -0,0 +1,2 @@
# All Modules
_See also the <a href="../java/index.html" target="_blank">Java API documentation (Javadoc)</a>._