Bundle Javadoc with Antora documentation site.

Closes #585
This commit is contained in:
Mark Paluch
2024-07-31 09:36:52 +02:00
parent 7561676af3
commit 7f1da244ec
6 changed files with 22 additions and 8 deletions

1
.gitignore vendored
View File

@@ -10,7 +10,6 @@ target/
/.idea/ /.idea/
node_modules node_modules
node node
package.json
package-lock.json package-lock.json
build/ build/
.mvn/.gradle-enterprise .mvn/.gradle-enterprise

10
package.json Normal file
View File

@@ -0,0 +1,10 @@
{
"dependencies": {
"antora": "3.2.0-alpha.6",
"@antora/atlas-extension": "1.0.0-alpha.2",
"@antora/collector-extension": "1.0.0-alpha.7",
"@asciidoctor/tabs": "1.0.0-beta.6",
"@springio/antora-extensions": "1.13.0",
"@springio/asciidoctor-extensions": "1.0.0-alpha.11"
}
}

View File

@@ -99,7 +99,7 @@
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>io.spring.maven.antora</groupId> <groupId>org.antora</groupId>
<artifactId>antora-maven-plugin</artifactId> <artifactId>antora-maven-plugin</artifactId>
</plugin> </plugin>
</plugins> </plugins>

View File

@@ -3,8 +3,7 @@
# The purpose of this Antora playbook is to build the docs in the current branch. # The purpose of this Antora playbook is to build the docs in the current branch.
antora: antora:
extensions: extensions:
- '@antora/collector-extension' - require: '@springio/antora-extensions'
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'data-keyvalue' root_component_name: 'data-keyvalue'
site: site:
title: Spring Data KeyValue title: Spring Data KeyValue
@@ -22,13 +21,12 @@ content:
start_path: src/main/antora start_path: src/main/antora
asciidoc: asciidoc:
attributes: attributes:
page-pagination: ''
hide-uri-scheme: '@' hide-uri-scheme: '@'
tabs-sync-option: '@' tabs-sync-option: '@'
chomp: 'all'
extensions: extensions:
- '@asciidoctor/tabs' - '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions' - '@springio/asciidoctor-extensions'
- '@springio/asciidoctor-extensions/javadoc-extension'
sourcemap: true sourcemap: true
urls: urls:
latest_version_segment: '' latest_version_segment: ''
@@ -38,5 +36,5 @@ runtime:
format: pretty format: pretty
ui: ui:
bundle: bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.5/ui-bundle.zip url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.16/ui-bundle.zip
snapshot: true snapshot: true

View File

@@ -10,3 +10,8 @@ ext:
local: true local: true
scan: scan:
dir: target/classes/ dir: target/classes/
- run:
command: ./mvnw package -Pdistribute
local: true
scan:
dir: target/antora

View File

@@ -10,4 +10,6 @@
** xref:repositories/query-keywords-reference.adoc[] ** xref:repositories/query-keywords-reference.adoc[]
** xref:repositories/query-return-types-reference.adoc[] ** xref:repositories/query-return-types-reference.adoc[]
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki] * xref:attachment$api/java/index.html[Javadoc,role=link-external,window=_blank]
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki,role=link-external,window=_blank]