SWS-1086 - Updated reference documentation.

Update look and feel to current team standards.
This commit is contained in:
Jay Bryant
2020-03-23 09:07:12 -05:00
committed by Greg Turnquist
parent b25f597cd9
commit 49f162665e
2 changed files with 76 additions and 8 deletions

77
pom.xml
View File

@@ -122,6 +122,7 @@
<xmlunit.version>1.5</xmlunit.version>
<xws-security.version>3.0</xws-security.version>
<xom.version>1.2.5</xom.version>
<docs.resources.version>0.1.3.RELEASE</docs.resources.version>
</properties>
<dependencyManagement>
@@ -187,7 +188,13 @@
<version>${woodstox.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.spring.docresources</groupId>
<artifactId>spring-doc-resources</artifactId>
<version>${docs.resources.version}</version>
<type>zip</type>
<optional>true</optional>
</dependency>
</dependencies>
<build>
@@ -520,7 +527,52 @@
<id>docs</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack-doc-resources</id>
<goals>
<goal>unpack-dependencies</goal>
</goals>
<phase>generate-resources</phase>
<inherited>false</inherited>
<configuration>
<includeGroupIds>io.spring.docresources</includeGroupIds>
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
<includeTypes>zip</includeTypes>
<excludeTransitive>true</excludeTransitive>
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-asciidoc-resources</id>
<phase>generate-resources</phase>
<inherited>false</inherited>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
<resources>
<resource>
<directory>src/main/asciidoctor</directory>
<filtering>false</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
@@ -536,15 +588,23 @@
<execution>
<id>html</id>
<phase>generate-resources</phase>
<inherited>false</inherited>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<outputDirectory>${project.build.directory}/site/reference/html</outputDirectory>
<sourceHighlighter>prettify</sourceHighlighter>
<sourceHighlighter>highlight.js</sourceHighlighter>
<attributes>
// these attributes are required to use the doc resources
<docinfo>shared</docinfo>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
<linkcss>true</linkcss>
<icons>font</icons>
<highlightjsdir>js/highlight</highlightjsdir>
<highlightjs-theme>github</highlightjs-theme>
<sectanchors>true</sectanchors>
</attributes>
</configuration>
@@ -553,6 +613,7 @@
<execution>
<id>pdf</id>
<phase>generate-resources</phase>
<inherited>false</inherited>
<goals>
<goal>process-asciidoc</goal>
</goals>
@@ -564,7 +625,7 @@
</executions>
<configuration>
<sourceDirectory>src/main/asciidoctor</sourceDirectory>
<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<doctype>book</doctype>
<attributes>
@@ -572,7 +633,7 @@
<projectName>${project.name}</projectName>
<projectVersion>${project.version}</projectVersion>
<allow-uri-read>true</allow-uri-read>
<toclevels>3</toclevels>
<toclevels>4</toclevels>
<numbered>true</numbered>
<baseDir>${project.basedir}</baseDir>
</attributes>
@@ -788,6 +849,14 @@
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-release</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>

View File

@@ -1,18 +1,17 @@
= Spring Web Services Reference Documentation
Arjen Poutsma, Rick Evans, Tareq Abed Rabbo, Greg Turnquist
:doctype: book
:revnumber: {version}
:revdate: {localdate}
:toc:
:toc: left
:toclevels: 4
:toc-placement!:
:source-highlighter: prettify
:sectnumlevels: 3
(C) 2005-2017 The original authors.
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.
toc::[]
:sectnums!:
[[spring-framework-reference]]