Bundle Javadoc with Antora

- Remove javadoc related tasks from root project
- Add aggregated javadoc task to spring-shell-docs
- Various antora version updates
- Bundle javadoc via collector into antora build
- Remove refs to distZip in workflows
- Relates #1132
This commit is contained in:
Janne Valkealahti
2024-08-29 08:39:56 +01:00
parent 208e41ba7b
commit 6983ef5c10
11 changed files with 66 additions and 258 deletions

View File

@@ -3,12 +3,7 @@
# The purpose of this Antora playbook is to build the docs in the current branch.
antora:
extensions:
- '@springio/antora-extensions/partial-build-extension'
- require: '@springio/antora-extensions/latest-version-extension'
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
- '@antora/collector-extension'
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/root-component-extension'
- require: '@springio/antora-extensions'
root_component_name: 'shell'
- require: '@springio/antora-extensions/asciinema-extension'
site:
@@ -30,6 +25,7 @@ asciidoc:
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
- '@springio/asciidoctor-extensions/javadoc-extension'
sourcemap: true
urls:
latest_version_segment: ''

View File

@@ -5,11 +5,16 @@ nav:
- modules/ROOT/nav.adoc
ext:
collector:
run:
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-shell-docs:generateAntoraYml
local: true
scan:
dir: ./build/generated-antora-resources
- run:
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-shell-docs:generateAntoraYml
local: true
scan:
dir: ./build/generated-antora-resources
- run:
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-shell-docs:aggregatedJavadoc
local: true
scan:
dir: ./build/generated-antora-javadocs
asciidoc:
attributes:

View File

@@ -96,4 +96,5 @@
** xref:appendices/debugging/index.adoc[]
** xref:appendices/tui/index.adoc[]
*** xref:appendices/tui/viewdev.adoc[]
*** xref:appendices/tui/catalog.adoc[]
*** xref:appendices/tui/catalog.adoc[]
* xref:attachment$api/java/index.html[Javadoc,role=link-external,window=_blank]

View File

@@ -15,22 +15,35 @@ dependencies {
testImplementation 'org.awaitility:awaitility'
}
node {
version = '16.15.0'
jar {
enabled = false
}
javadoc {
enabled = false
}
javadocJar {
enabled = false
}
sourcesJar {
enabled = false
}
antora {
version = '3.2.0-alpha.2'
version = '3.2.0-alpha.6'
if (project.hasProperty('antoraLocalBarePlaybook') && antoraLocalBarePlaybook.toBoolean()) {
playbook = 'local-bare-antora-playbook.yml'
}
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
dependencies = [
'@antora/atlas-extension': '1.0.0-alpha.1',
'@antora/collector-extension': '1.0.0-alpha.3',
'@asciidoctor/tabs': '1.0.0-beta.3',
'@springio/antora-extensions': '1.8.1',
'@springio/asciidoctor-extensions': '1.0.0-alpha.8',
'@antora/collector-extension': '1.0.0-alpha.7',
'@asciidoctor/tabs': '1.0.0-beta.6',
'@springio/antora-extensions': '1.14.2',
'@springio/asciidoctor-extensions': '1.0.0-alpha.12',
'asciinema-player': '3.7.1'
]
}