Skip to content

Commit bdd141e

Browse files
Jay Bryantgregturn
authored andcommitted
SWS-1086 - Updated reference documentation.
Update look and feel to current team standards.
1 parent 75511a6 commit bdd141e

File tree

2 files changed

+76
-8
lines changed

2 files changed

+76
-8
lines changed

pom.xml

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@
119119
<xmlunit.version>1.5</xmlunit.version>
120120
<xws-security.version>3.0</xws-security.version>
121121
<xom.version>1.2.5</xom.version>
122+
<docs.resources.version>0.1.3.RELEASE</docs.resources.version>
122123
</properties>
123124

124125
<dependencyManagement>
@@ -184,7 +185,13 @@
184185
<version>${woodstox.version}</version>
185186
<scope>test</scope>
186187
</dependency>
187-
188+
<dependency>
189+
<groupId>io.spring.docresources</groupId>
190+
<artifactId>spring-doc-resources</artifactId>
191+
<version>${docs.resources.version}</version>
192+
<type>zip</type>
193+
<optional>true</optional>
194+
</dependency>
188195
</dependencies>
189196

190197
<build>
@@ -466,7 +473,52 @@
466473
<id>docs</id>
467474

468475
<build>
476+
469477
<plugins>
478+
<plugin>
479+
<groupId>org.apache.maven.plugins</groupId>
480+
<artifactId>maven-dependency-plugin</artifactId>
481+
<executions>
482+
<execution>
483+
<id>unpack-doc-resources</id>
484+
<goals>
485+
<goal>unpack-dependencies</goal>
486+
</goals>
487+
<phase>generate-resources</phase>
488+
<inherited>false</inherited>
489+
<configuration>
490+
<includeGroupIds>io.spring.docresources</includeGroupIds>
491+
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
492+
<includeTypes>zip</includeTypes>
493+
<excludeTransitive>true</excludeTransitive>
494+
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
495+
</configuration>
496+
</execution>
497+
</executions>
498+
</plugin>
499+
<plugin>
500+
<groupId>org.apache.maven.plugins</groupId>
501+
<artifactId>maven-resources-plugin</artifactId>
502+
<executions>
503+
<execution>
504+
<id>copy-asciidoc-resources</id>
505+
<phase>generate-resources</phase>
506+
<inherited>false</inherited>
507+
<goals>
508+
<goal>copy-resources</goal>
509+
</goals>
510+
<configuration>
511+
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
512+
<resources>
513+
<resource>
514+
<directory>src/main/asciidoctor</directory>
515+
<filtering>false</filtering>
516+
</resource>
517+
</resources>
518+
</configuration>
519+
</execution>
520+
</executions>
521+
</plugin>
470522
<plugin>
471523
<groupId>org.asciidoctor</groupId>
472524
<artifactId>asciidoctor-maven-plugin</artifactId>
@@ -482,15 +534,23 @@
482534
<execution>
483535
<id>html</id>
484536
<phase>generate-resources</phase>
537+
<inherited>false</inherited>
485538
<goals>
486539
<goal>process-asciidoc</goal>
487540
</goals>
488541
<configuration>
489542
<backend>html5</backend>
490543
<outputDirectory>${project.build.directory}/site/reference/html</outputDirectory>
491-
<sourceHighlighter>prettify</sourceHighlighter>
544+
<sourceHighlighter>highlight.js</sourceHighlighter>
492545
<attributes>
546+
// these attributes are required to use the doc resources
547+
<docinfo>shared</docinfo>
548+
<stylesdir>css/</stylesdir>
549+
<stylesheet>spring.css</stylesheet>
550+
<linkcss>true</linkcss>
493551
<icons>font</icons>
552+
<highlightjsdir>js/highlight</highlightjsdir>
553+
<highlightjs-theme>github</highlightjs-theme>
494554
<sectanchors>true</sectanchors>
495555
</attributes>
496556
</configuration>
@@ -499,6 +559,7 @@
499559
<execution>
500560
<id>pdf</id>
501561
<phase>generate-resources</phase>
562+
<inherited>false</inherited>
502563
<goals>
503564
<goal>process-asciidoc</goal>
504565
</goals>
@@ -510,15 +571,15 @@
510571
</executions>
511572

512573
<configuration>
513-
<sourceDirectory>src/main/asciidoctor</sourceDirectory>
574+
<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
514575
<sourceDocumentName>index.adoc</sourceDocumentName>
515576
<doctype>book</doctype>
516577
<attributes>
517578
<version>${project.version}</version>
518579
<projectName>${project.name}</projectName>
519580
<projectVersion>${project.version}</projectVersion>
520581
<allow-uri-read>true</allow-uri-read>
521-
<toclevels>3</toclevels>
582+
<toclevels>4</toclevels>
522583
<numbered>true</numbered>
523584
<baseDir>${project.basedir}</baseDir>
524585
</attributes>
@@ -731,6 +792,14 @@
731792
<enabled>false</enabled>
732793
</snapshots>
733794
</repository>
795+
<repository>
796+
<id>spring-release</id>
797+
<name>Spring Releases</name>
798+
<url>https://repo.spring.io/release</url>
799+
<snapshots>
800+
<enabled>false</enabled>
801+
</snapshots>
802+
</repository>
734803
</repositories>
735804

736805
<pluginRepositories>

src/main/asciidoctor/index.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
= Spring Web Services Reference Documentation
22
Arjen Poutsma, Rick Evans, Tareq Abed Rabbo, Greg Turnquist
3+
:doctype: book
34
:revnumber: {version}
45
:revdate: {localdate}
5-
:toc:
6+
:toc: left
67
:toclevels: 4
7-
:toc-placement!:
8+
:source-highlighter: prettify
89
:sectnumlevels: 3
910

1011
(C) 2005-2017 The original authors.
1112

1213
NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
1314

14-
toc::[]
15-
1615
:sectnums!:
1716

1817
[[spring-framework-reference]]

0 commit comments

Comments
 (0)