Skip to content

Commit

Permalink
Use spring-asciidoctor-backends for documentation generation
Browse files Browse the repository at this point in the history 
Resolves #3865
  • Loading branch information
@fmbenhassine
Jay Bryant authored and fmbenhassine committed Aug 21, 2022
1 parent c506a49 commit f89aa20
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 115 deletions.
2 changes: 1 addition & 1 deletion pom.xml
View file
Expand Up @@ -144,7 +144,7 @@
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
<maven-jar-plugin.version>3.2.2</maven-jar-plugin.version>
<build-helper-maven-plugin.version>3.3.0</build-helper-maven-plugin.version>
<spring-javaformat-maven-plugin.version>0.0.32</spring-javaformat-maven-plugin.version>
<spring-javaformat-maven-plugin.version>0.0.34</spring-javaformat-maven-plugin.version>
</properties>

<build>
Expand Down
60 changes: 15 additions & 45 deletions spring-batch-docs/pom.xml
View file
Expand Up @@ -10,15 +10,6 @@
<name>Spring Batch Docs</name>
<description>Spring Batch documentation</description>

<dependencies>
<dependency>
<groupId>io.spring.docresources</groupId>
<artifactId>spring-doc-resources</artifactId>
<version>${spring-doc-resources.version}</version>
<type>zip</type>
</dependency>
</dependencies>

<build>
<resources>
<resource>
Expand All @@ -30,36 +21,10 @@
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${maven-resources-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>${maven-dependency-plugin.version}</version>
<executions>
<execution>
<id>unpack-resources</id>
<phase>pre-site</phase>
<goals>
<goal>unpack-dependencies</goal>
</goals>
<configuration>
<includeGroupIds>io.spring.docresources</includeGroupIds>
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
<includeTypes>zip</includeTypes>
<excludeTransitive>true</excludeTransitive>
<outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor-maven-plugin.version}</version>
<version>2.1.0</version>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
Expand All @@ -71,6 +36,11 @@
<artifactId>asciidoctorj-epub3</artifactId>
<version>${asciidoctorj-epub.version}</version>
</dependency>
<dependency>
<groupId>io.spring.asciidoctor.backends</groupId>
<artifactId>spring-asciidoctor-backends</artifactId>
<version>0.0.3</version>
</dependency>
</dependencies>
<configuration>
<sourceDirectory>${project.basedir}/src/main/asciidoc</sourceDirectory>
Expand All @@ -84,13 +54,13 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<backend>spring-html</backend>
<doctype>book</doctype>
<attributes>
<docinfodir>${project.build.directory}/asciidoc</docinfodir>
<docinfo>shared</docinfo>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
<stylesheet>site.css</stylesheet>
<linkcss>true</linkcss>
<icons>font</icons>
<sectanchors />
Expand Down Expand Up @@ -215,13 +185,13 @@

<repositories>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/libs-release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<id>spring-release</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>

</project>
9 changes: 5 additions & 4 deletions spring-batch-docs/src/assembly/dist.xml
View file
Expand Up @@ -15,6 +15,7 @@
<includes>
<include>css/*.*</include>
<include>images/*.*</include>
<include>img/*.*</include>
<include>js/**/*.*</include>
<include>*.html</include>
</includes>
Expand Down Expand Up @@ -77,13 +78,13 @@
<outputDirectory>docs/reference/pdf</outputDirectory>
</file>
<file>
<source>target/classes/license.txt</source>
<source>src/dist/license.txt</source>
</file>
<file>
<source>target/classes/notice.txt</source>
<source>src/dist/notice.txt</source>
</file>
<file>
<source>target/classes/readme.txt</source>
<source>src/dist/readme.txt</source>
</file>
</files>
</assembly>
</assembly>
1 change: 1 addition & 0 deletions spring-batch-docs/src/assembly/docs.xml
View file
Expand Up @@ -13,6 +13,7 @@
<includes>
<include>css/*.*</include>
<include>images/*.*</include>
<include>img/*.*</include>
<include>js/**/*.*</include>
<include>*.html</include>
</includes>
Expand Down
3 changes: 0 additions & 3 deletions spring-batch-docs/src/main/asciidoc/js/DocumentToggle.js
View file
Expand Up @@ -52,7 +52,6 @@ $(document).ready(function(){
$javaContentAll.addClass("js-toc-ignore");
$xmlContentAll.removeClass("js-toc-ignore");
window.dispatchEvent(new Event("tocRefresh"));
tocbot.refresh();
window.localStorage.setItem('docToggle', 'xml');
}

Expand All @@ -62,7 +61,6 @@ $(document).ready(function(){
$xmlContentAll.addClass("js-toc-ignore");
$javaContentAll.removeClass("js-toc-ignore");
window.dispatchEvent(new Event("tocRefresh"));
tocbot.refresh();
window.localStorage.setItem('docToggle', 'java');
}

Expand All @@ -72,7 +70,6 @@ $(document).ready(function(){
$javaContentAll.removeClass("js-toc-ignore");
$xmlContentAll.removeClass("js-toc-ignore");
window.dispatchEvent(new Event("tocRefresh"));
tocbot.refresh();
window.localStorage.setItem('docToggle', 'both');
}

Expand Down
62 changes: 0 additions & 62 deletions spring-batch-docs/src/main/asciidoc/jsfiles/DocumentToggle.js
View file

This file was deleted.

0 comments on commit f89aa20

Please sign in to comment.