Skip to content

Commit 6ccba8c

Browse files
committed
Bundle Javadoc with Antora documentation site.
Closes #491
1 parent a8ce5c5 commit 6ccba8c

File tree

7 files changed

+23
-9
lines changed

7 files changed

+23
-9
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ src/ant/.ant-targets-upload-dist.xml
1515
atlassian-ide-plugin.xml
1616
/.gradle/
1717
/.idea/
18-
package.json
1918
package-lock.json
2019
node
2120
node_modules

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
@@ -132,7 +132,7 @@
132132
<build>
133133
<plugins>
134134
<plugin>
135-
<groupId>io.spring.maven.antora</groupId>
135+
<groupId>org.antora</groupId>
136136
<artifactId>antora-maven-plugin</artifactId>
137137
</plugin>
138138
</plugins>

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-ldap'
98
site:
109
title: Spring Data LDAP
@@ -22,13 +21,12 @@ content:
2221
start_path: src/main/antora
2322
asciidoc:
2423
attributes:
25-
page-pagination: ''
2624
hide-uri-scheme: '@'
2725
tabs-sync-option: '@'
28-
chomp: 'all'
2926
extensions:
3027
- '@asciidoctor/tabs'
3128
- '@springio/asciidoctor-extensions'
29+
- '@springio/asciidoctor-extensions/javadoc-extension'
3230
sourcemap: true
3331
urls:
3432
latest_version_segment: ''
@@ -38,5 +36,5 @@ runtime:
3836
format: pretty
3937
ui:
4038
bundle:
41-
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
39+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.16/ui-bundle.zip
4240
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/
13+
- run:
14+
command: ./mvnw package -Pdistribute
15+
local: true
16+
scan:
17+
dir: target/antora

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,6 @@
1919
** xref:ldap/query-methods.adoc[]
2020
** xref:ldap/querydsl.adoc[]
2121
** xref:ldap/cdi-integration.adoc[]
22-
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki]
22+
23+
* xref:attachment$api/java/index.html[Javadoc,role=link-external,window=_blank]
24+
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki,role=link-external,window=_blank]

src/main/antora/modules/ROOT/pages/ldap/configuration.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ All Spring LDAP repositories must work with entities annotated with the ODM anno
1313

1414
Since all ODM managed classes must have a Distinguished Name as the ID, all Spring LDAP repositories must have the ID type parameter set to `javax.naming.Name`.
1515

16-
Indeed, the built-in `LdapRepository` only takes one type parameter: the managed entity class, which defaults the ID to `javax.naming.Name`.
16+
Indeed, the built-in javadoc:org.springframework.data.ldap.repository.LdapRepository[] only takes one type parameter: the managed entity class, which defaults the ID to `javax.naming.Name`.
1717

1818
Due to specifics of the LDAP protocol, paging and sorting are not supported for Spring LDAP repositories.
1919

0 commit comments

Comments
 (0)