Skip to content

Commit 9804c75

Browse files
committed
Bundle Javadoc with Antora documentation site.
Closes #3128
1 parent 24f8d90 commit 9804c75

File tree

6 files changed

+22
-7
lines changed

6 files changed

+22
-7
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,4 @@ src/ant/.ant-targets-upload-dist.xml
1818
node
1919
node_modules
2020
package-lock.json
21-
package.json
2221
.mvn/.gradle-enterprise

package.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"dependencies": {
3+
"antora": "3.2.0-alpha.6",
4+
"@antora/atlas-extension": "1.0.0-alpha.2",
5+
"@antora/collector-extension": "1.0.0-alpha.7",
6+
"@asciidoctor/tabs": "1.0.0-beta.6",
7+
"@springio/antora-extensions": "1.13.0",
8+
"@springio/asciidoctor-extensions": "1.0.0-alpha.11"
9+
}
10+
}

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@
340340
<artifactId>maven-assembly-plugin</artifactId>
341341
</plugin>
342342
<plugin>
343-
<groupId>io.spring.maven.antora</groupId>
343+
<groupId>org.antora</groupId>
344344
<artifactId>antora-maven-plugin</artifactId>
345345
</plugin>
346346
<plugin>

src/main/antora/antora-playbook.yml

+3-5
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
# The purpose of this Antora playbook is to build the docs in the current branch.
44
antora:
55
extensions:
6-
- '@antora/collector-extension'
7-
- require: '@springio/antora-extensions/root-component-extension'
6+
- require: '@springio/antora-extensions'
87
root_component_name: 'data-commons'
98
site:
109
title: Spring Data Reference
@@ -17,13 +16,12 @@ content:
1716
worktrees: true
1817
asciidoc:
1918
attributes:
20-
page-pagination: ''
2119
hide-uri-scheme: '@'
2220
tabs-sync-option: '@'
23-
chomp: 'all'
2421
extensions:
2522
- '@asciidoctor/tabs'
2623
- '@springio/asciidoctor-extensions'
24+
- '@springio/asciidoctor-extensions/javadoc-extension'
2725
sourcemap: true
2826
urls:
2927
latest_version_segment: ''
@@ -33,5 +31,5 @@ runtime:
3331
format: pretty
3432
ui:
3533
bundle:
36-
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
34+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.16/ui-bundle.zip
3735
snapshot: true

src/main/antora/antora.yml

+5
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,8 @@ ext:
1010
local: true
1111
scan:
1212
dir: target/classes/antora-resources/
13+
- run:
14+
command: ./mvnw package -Pdistribute
15+
local: true
16+
scan:
17+
dir: target/antora

src/main/antora/modules/ROOT/nav.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,6 @@
3131
** xref:repositories/populator-namespace-reference.adoc[]
3232
** xref:repositories/query-keywords-reference.adoc[]
3333
** xref:repositories/query-return-types-reference.adoc[]
34+
35+
* xref:attachment$api/java/index.html[Javadoc,role=link-external,window=_blank]
36+
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki,role=link-external,window=_blank]

0 commit comments

Comments
 (0)