Skip to content

Commit 6e49231

Browse files
mp911demp911de
committed
Switch to spring-asciidoctor-backends.
See #2008
1 parent f3c7b72 commit 6e49231

File tree

1 file changed

+36
-72
lines changed

1 file changed

+36
-72
lines changed

‎parent/pom.xml‎

Lines changed: 36 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@
128128
<smallrye-mutiny>1.4.0</smallrye-mutiny>
129129
<slf4j>1.7.32</slf4j>
130130
<spring>5.3.27</spring>
131+
<spring-asciidoctor-backends.version>0.0.5</spring-asciidoctor-backends.version>
131132
<spring-hateoas>1.5.4</spring-hateoas>
132133
<spring-plugin>2.0.0.RELEASE</spring-plugin>
133134
<testcontainers>1.17.6</testcontainers>
@@ -276,7 +277,8 @@
276277
<exclude>org.springframework.data:*</exclude>
277278
</excludes>
278279
</requireReleaseDeps>
279-
<NoSnapshotDependenciesInDependencyManagementRule implementation="de.smartics.maven.enforcer.rule.NoSnapshotsInDependencyManagementRule">
280+
<NoSnapshotDependenciesInDependencyManagementRule
281+
implementation="de.smartics.maven.enforcer.rule.NoSnapshotsInDependencyManagementRule">
280282
<onlyWhenRelease>true</onlyWhenRelease>
281283
</NoSnapshotDependenciesInDependencyManagementRule>
282284
</rules>
@@ -333,8 +335,6 @@
333335

334336
<properties>
335337
<shared.resources>${project.build.directory}/shared-resources</shared.resources>
336-
<generated-asciidoc-sources.directory>${project.build.directory}/generated-asciidoc-sources/source/
337-
</generated-asciidoc-sources.directory>
338338
<generated-docs.directory>${project.build.directory}/generated-docs</generated-docs.directory>
339339
<maven.test.skip>true</maven.test.skip>
340340
<aspectj.skip>true</aspectj.skip>
@@ -343,13 +343,6 @@
343343
</properties>
344344

345345
<dependencies>
346-
<dependency>
347-
<groupId>io.spring.docresources</groupId>
348-
<artifactId>spring-doc-resources</artifactId>
349-
<version>0.2.5</version>
350-
<type>zip</type>
351-
<optional>true</optional>
352-
</dependency>
353346
<dependency>
354347
<groupId>org.springframework.data.build</groupId>
355348
<artifactId>spring-data-build-resources</artifactId>
@@ -389,20 +382,6 @@
389382
<groupId>org.apache.maven.plugins</groupId>
390383
<artifactId>maven-dependency-plugin</artifactId>
391384
<executions>
392-
<execution>
393-
<id>unpack-doc-resources</id>
394-
<goals>
395-
<goal>unpack-dependencies</goal>
396-
</goals>
397-
<phase>generate-resources</phase>
398-
<configuration>
399-
<includeGroupIds>io.spring.docresources</includeGroupIds>
400-
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
401-
<includeTypes>zip</includeTypes>
402-
<excludeTransitive>true</excludeTransitive>
403-
<outputDirectory>${generated-asciidoc-sources.directory}</outputDirectory>
404-
</configuration>
405-
</execution>
406385
<execution>
407386
<id>unpack-shared-resources</id>
408387
<goals>
@@ -427,6 +406,10 @@
427406
<plugin>
428407
<groupId>org.apache.maven.plugins</groupId>
429408
<artifactId>maven-javadoc-plugin</artifactId>
409+
<configuration>
410+
<javadocDirectory>${shared.resources}/javadoc</javadocDirectory>
411+
<overview>${shared.resources}/javadoc/overview.html</overview>
412+
</configuration>
430413
<executions>
431414
<execution>
432415
<id>aggregate-javadoc</id>
@@ -463,61 +446,23 @@
463446
</goals>
464447
</execution>
465448

466-
<execution>
467-
<id>create-generated-docs-resources</id>
468-
<phase>process-resources</phase>
469-
<configuration>
470-
<target>
471-
<copy failonerror="false" todir="${generated-asciidoc-sources.directory}/">
472-
<fileset dir="${project.root}/src/main/asciidoc" includes="**/*.adoc"/>
473-
</copy>
474-
<copy failonerror="false" todir="${generated-asciidoc-sources.directory}/images/">
475-
<fileset dir="${project.root}/src/main/asciidoc/images"/>
476-
</copy>
477-
478-
<copy todir="${generated-docs.directory}">
479-
<fileset dir="${generated-asciidoc-sources.directory}">
480-
<include name="css/**"/>
481-
<include name="js/**"/>
482-
</fileset>
483-
</copy>
484-
</target>
485-
</configuration>
486-
<goals>
487-
<goal>run</goal>
488-
</goals>
489-
</execution>
490-
491449
<execution>
492450
<id>rename-reference-docs</id>
493451
<phase>prepare-package</phase>
494452
<configuration>
495453
<target>
496454

497455
<!-- Copy files for the single-file HTML version -->
498-
<copy failonerror="false" todir="${project.root}/target/site/reference/html/images">
499-
<fileset dir="${generated-docs.directory}/images"/>
500-
</copy>
501-
502-
<!-- Copy shared resources. Spring Data ones first to override the ones shared -->
503-
<copy failonerror="false" todir="${project.root}/target/site/reference/html/">
504-
<fileset dir="${shared.resources}">
505-
<include name="css/**"/>
506-
<include name="js/**"/>
507-
</fileset>
508-
</copy>
509-
510-
<copy failonerror="false" todir="${project.root}/target/site/reference/html/">
511-
<fileset dir="${generated-asciidoc-sources.directory}">
456+
<copy failonerror="false" todir="${project.root}/target/site/reference/html">
457+
<fileset dir="${generated-docs.directory}">
458+
<include name="img/**"/>
459+
<include name="images/**"/>
512460
<include name="css/**"/>
513461
<include name="js/**"/>
462+
<include name="**/*.html"/>
514463
</fileset>
515464
</copy>
516465

517-
<copy failonerror="false" todir="${project.root}/target/site/reference/html/">
518-
<fileset dir="${generated-docs.directory}" includes="*.html"/>
519-
</copy>
520-
521466
<!-- Copy and rename the Epub file -->
522467
<copy failonerror="false" file="${generated-docs.directory}/index.pdf" tofile="${project.root}/target/site/reference/pdf/${dist.id}-reference.pdf"/>
523468

@@ -561,9 +506,9 @@
561506
<goal>process-asciidoc</goal>
562507
</goals>
563508
<configuration>
564-
<sourceDirectory>${generated-asciidoc-sources.directory}</sourceDirectory>
509+
<sourceDirectory>${project.root}/src/main/asciidoc</sourceDirectory>
565510
<sourceDocumentName>index.adoc</sourceDocumentName>
566-
<backend>html5</backend>
511+
<backend>spring-html</backend>
567512
<outputDirectory>${generated-docs.directory}</outputDirectory>
568513
<attributes>
569514
<source-highlighter>highlight.js</source-highlighter>
@@ -572,7 +517,7 @@
572517
<linkcss>true</linkcss>
573518
<sectanchors>true</sectanchors>
574519
<stylesdir>./css</stylesdir>
575-
<stylesheet>spring.css</stylesheet>
520+
<stylesheet>site.css</stylesheet>
576521
<toc>left</toc>
577522
</attributes>
578523
</configuration>
@@ -592,14 +537,16 @@
592537
<projectVersion>${project.version}</projectVersion>
593538
<aspectjVersion>${aspectj}</aspectjVersion>
594539
<querydslVersion>${querydsl}</querydslVersion>
540+
<springDocsUrl>https://docs.spring.io/spring-framework/docs/${spring}/reference/html/</springDocsUrl>
541+
<springJavadocUrl>https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api/</springJavadocUrl>
595542
<springVersion>${spring}</springVersion>
543+
<springHateoasVersion>${spring-hateoas}</springHateoasVersion>
596544
<releasetrainVersion>${releasetrain}</releasetrainVersion>
597545
<allow-uri-read>true</allow-uri-read>
598546
<toclevels>4</toclevels>
599547
<numbered>true</numbered>
600548
</attributes>
601549
</configuration>
602-
603550
</plugin>
604551

605552
<!--
@@ -1037,7 +984,24 @@
1037984
<plugin>
1038985
<groupId>org.asciidoctor</groupId>
1039986
<artifactId>asciidoctor-maven-plugin</artifactId>
1040-
<version>2.2.2</version>
987+
<version>2.2.3</version>
988+
<dependencies>
989+
<dependency>
990+
<groupId>org.jruby</groupId>
991+
<artifactId>jruby</artifactId>
992+
<version>9.3.7.0</version>
993+
</dependency>
994+
<dependency>
995+
<groupId>org.asciidoctor</groupId>
996+
<artifactId>asciidoctorj</artifactId>
997+
<version>2.5.7</version>
998+
</dependency>
999+
<dependency>
1000+
<groupId>io.spring.asciidoctor.backends</groupId>
1001+
<artifactId>spring-asciidoctor-backends</artifactId>
1002+
<version>${spring-asciidoctor-backends.version}</version>
1003+
</dependency>
1004+
</dependencies>
10411005
</plugin>
10421006

10431007
<plugin>

0 commit comments

Comments
 (0)