Browse Source

Deploy JavaDoc with Antora

Closes gh-2243
pull/2246/head
Josh Cummings 4 weeks ago
parent
commit
88e63d633c
No known key found for this signature in database
GPG Key ID: 869B37A20E876129
  1. 2
      docs/antora.yml
  2. 1
      docs/modules/ROOT/nav.adoc
  3. 10
      docs/spring-authorization-server-docs.gradle

2
docs/antora.yml

@ -6,7 +6,7 @@ nav: @@ -6,7 +6,7 @@ nav:
ext:
collector:
run:
command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-authorization-server-docs:generateAntoraYml
command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-authorization-server-docs:generateAntoraResources
local: true
scan:
dir: ./build/generated-antora-resources

1
docs/modules/ROOT/nav.adoc

@ -1,6 +1,7 @@ @@ -1,6 +1,7 @@
* xref:overview.adoc[]
* xref:getting-help.adoc[]
* xref:getting-started.adoc[]
* xref:attachment$api/java/index.html[Javadoc]
* xref:configuration-model.adoc[]
* xref:core-model-components.adoc[]
* xref:protocol-endpoints.adoc[]

10
docs/spring-authorization-server-docs.gradle

@ -24,10 +24,20 @@ antora { @@ -24,10 +24,20 @@ antora {
]
}
tasks.register("syncAntoraAttachments", Sync) {
group = 'Documentation'
description = 'Syncs the Antora attachments'
from project.provider( { project.tasks.api.outputs } )
into project.layout.buildDirectory.dir('generated-antora-resources/modules/ROOT/assets/attachments/api/java')
}
tasks.named("generateAntoraYml") {
asciidocAttributes = project.provider( { generateAttributes() } )
}
tasks.register("generateAntoraResources") {
dependsOn 'generateAntoraYml', 'syncAntoraAttachments'
}
def generateAttributes() {
return [

Loading…
Cancel
Save