Browse Source

Bundle Javadoc with Antora documentation site.

Closes #3128
3.2.x
Mark Paluch 1 year ago
parent
commit
3b481609e6
No known key found for this signature in database
GPG Key ID: 55BC6374BAA9D973
  1. 1
      .gitignore
  2. 10
      package.json
  3. 2
      pom.xml
  4. 8
      src/main/antora/antora-playbook.yml
  5. 5
      src/main/antora/antora.yml
  6. 3
      src/main/antora/modules/ROOT/nav.adoc

1
.gitignore vendored

@ -18,5 +18,4 @@ src/ant/.ant-targets-upload-dist.xml @@ -18,5 +18,4 @@ src/ant/.ant-targets-upload-dist.xml
node
node_modules
package-lock.json
package.json
.mvn/.gradle-enterprise

10
package.json

@ -0,0 +1,10 @@ @@ -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"
}
}

2
pom.xml

@ -340,7 +340,7 @@ @@ -340,7 +340,7 @@
<artifactId>maven-assembly-plugin</artifactId>
</plugin>
<plugin>
<groupId>io.spring.maven.antora</groupId>
<groupId>org.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
</plugin>
<plugin>

8
src/main/antora/antora-playbook.yml

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

5
src/main/antora/antora.yml

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

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

@ -30,3 +30,6 @@ @@ -30,3 +30,6 @@
** xref:repositories/populator-namespace-reference.adoc[]
** xref:repositories/query-keywords-reference.adoc[]
** xref:repositories/query-return-types-reference.adoc[]
* 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]

Loading…
Cancel
Save