Spring/spring-vault
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use Spring documentation resources for a uniform documentation style.

Browse Source 
Closes gh-343.
This commit is contained in:
Mark Paluch
2018-12-07 16:33:00 +01:00
parent 5775483200
commit 56d4274080
2 changed files with 93 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

165
pom.xml
View File

@@ -545,22 +545,29 @@
<properties>
<maven.install.skip>true</maven.install.skip>
<skipTests>true</skipTests>
<shared.resources>${project.build.directory}/shared-resources
</shared.resources>
<generated-asciidoc-sources.directory>${project.build.directory}/generated-asciidoc-sources/source/
</generated-asciidoc-sources.directory>
<generated-docs.directory>${project.build.directory}/generated-docs</generated-docs.directory>
<maven.install.skip>true</maven.install.skip>
<skipTests>true</skipTests>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.doc-resources</groupId>
<groupId>io.spring.docresources</groupId>
<artifactId>spring-doc-resources</artifactId>
<version>0.1.1-SNAPSHOT</version>
<scope>provided</scope>
<version>0.1.0-BUILD-SNAPSHOT</version>
<type>zip</type>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data.build</groupId>
<artifactId>spring-data-build-resources</artifactId>
<version>2.0.0.RELEASE</version>
<scope>provided</scope>
<version>2.2.0.BUILD-SNAPSHOT</version>
<type>zip</type>
<optional>true</optional>
</dependency>
</dependencies>
@@ -590,29 +597,24 @@
</includeArtifactIds>
<includeTypes>zip</includeTypes>
<excludeTransitive>true</excludeTransitive>
<outputDirectory>${shared.resources}
</outputDirectory>
<outputDirectory>${shared.resources}</outputDirectory>
</configuration>
</execution>
<execution>
<id>unpack-doc-resource</id>
<id>unpack-doc-resources</id>
<goals>
<goal>unpack-dependencies</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<includeGroupIds>org.springframework.doc-resources
</includeGroupIds>
<includeArtifactIds>spring-doc-resources
</includeArtifactIds>
<includeGroupIds>io.spring.docresources</includeGroupIds>
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
<includeTypes>zip</includeTypes>
<excludeTransitive>true</excludeTransitive>
<outputDirectory>${doc.resources}
</outputDirectory>
<outputDirectory>${generated-asciidoc-sources.directory}</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
@@ -655,12 +657,14 @@
<configuration>
<target>
<copy todir="${project.root}/target/site/reference/html/images">
<fileset dir="${basedir}/src/main/asciidoc" erroronmissingdir="false">
<include name="**/*.png" />
<include name="**/*.gif" />
<include name="**/*.jpg" />
<fileset
dir="${basedir}/src/main/asciidoc"
erroronmissingdir="false">
<include name="**/*.png"/>
<include name="**/*.gif"/>
<include name="**/*.jpg"/>
</fileset>
<flattenmapper />
<flattenmapper/>
</copy>
</target>
</configuration>
@@ -671,14 +675,16 @@
<execution>
<id>collect-schema-files</id>
<phase>process-resources</phase>
<phase>prepare-package</phase>
<configuration>
<target>
<copy todir="${project.build.directory}/schemas">
<fileset dir="${basedir}" erroronmissingdir="false">
<include name="**/src/main/resources/**/config/spring-*.xsd" />
<fileset dir="${basedir}"
erroronmissingdir="false">
<include
name="**/src/main/resources/**/config/spring-*.xsd"/>
</fileset>
<flattenmapper />
<flattenmapper/>
</copy>
</target>
</configuration>
@@ -688,21 +694,28 @@
</execution>
<execution>
<id>create-docs-working-directory</id>
<phase>generate-resources</phase>
<id>create-generated-docs-resources</id>
<phase>process-resources</phase>
<configuration>
<target>
<copy failonerror="false" file="${project.build.directory}/doc-resources/stylesheets/spring.css" tofile="${project.build.directory}/working/stylesheets/spring.css" />
<copy failonerror="false" file="${project.build.directory}/doc-resources/html/docinfo.html" tofile="${project.build.directory}/working/docinfo.html" />
<copy failonerror="false" file="${project.build.directory}/doc-resources/html/docinfo-footer.html" tofile="${project.build.directory}/working/docinfo-footer.html" />
<copy failonerror="false" todir="${project.build.directory}/working/tocbot-3.0.2">
<fileset dir="${project.build.directory}/doc-resources/javascript/tocbot-3.0.2" includes="**" />
<copy failonerror="false"
todir="${generated-asciidoc-sources.directory}/">
<fileset
dir="${project.root}/src/main/asciidoc"
includes="**/*.adoc"/>
</copy>
<copy failonerror="false" todir="${project.build.directory}/working">
<fileset dir="${project.root}/src/main/asciidoc" includes="**" />
<copy failonerror="false"
todir="${generated-asciidoc-sources.directory}/images/">
<fileset
dir="${project.root}/src/main/asciidoc/images"/>
</copy>
<copy failonerror="false" todir="${project.build.directory}/working/images">
<fileset dir="${project.root}/src/main/asciidoc/images" includes="**" />
<copy todir="${generated-docs.directory}">
<fileset
dir="${generated-asciidoc-sources.directory}">
<include name="css/**"/>
<include name="js/**"/>
</fileset>
</copy>
</target>
</configuration>
@@ -716,23 +729,38 @@
<phase>prepare-package</phase>
<configuration>
<target>
<!-- Copy files for the single-file HTML version -->
<copy failonerror="false" file="${project.build.directory}/generated-docs/index.html" tofile="${project.root}/target/site/reference/html/index.html" />
<copy failonerror="false" todir="${project.root}/target/site/reference/html/images">
<fileset dir="${project.build.directory}/generated-docs/images">
<include name="*.*" />
<copy failonerror="false"
todir="${project.root}/target/site/reference/html/images">
<fileset
dir="${generated-docs.directory}/images"/>
</copy>
<copy failonerror="false"
todir="${project.root}/target/site/reference/html/">
<fileset
dir="${generated-asciidoc-sources.directory}">
<include name="css/**"/>
<include name="js/**"/>
</fileset>
</copy>
<copy failonerror="false" todir="${project.root}/target/site/reference/html/tocbot-3.0.2">
<fileset dir="${project.build.directory}/generated-docs/tocbot-3.0.2">
<include name="*.*" />
</fileset>
<copy failonerror="false"
todir="${project.root}/target/site/reference/html/">
<fileset dir="${generated-docs.directory}"
includes="*.html"/>
</copy>
<copy failonerror="false" file="${project.build.directory}/generated-docs/stylesheets/spring.css" tofile="${project.root}/target/site/reference/html/stylesheets/spring.css" />
<!-- Copy and rename the Epub file -->
<copy failonerror="false" file="${project.build.directory}/generated-docs/index.pdf" tofile="${project.root}/target/site/reference/pdf/${dist.id}-reference.pdf" />
<copy failonerror="false"
file="${generated-docs.directory}/index.pdf"
tofile="${project.root}/target/site/reference/pdf/${dist.id}-reference.pdf"/>
<!-- Copy and rename the PDF file -->
<copy failonerror="false" file="${project.build.directory}/generated-docs/index.epub" tofile="${project.root}/target/site/reference/epub/${dist.id}-reference.epub" />
<copy failonerror="false"
file="${generated-docs.directory}/index.epub"
tofile="${project.root}/target/site/reference/epub/${dist.id}-reference.epub"/>
</target>
</configuration>
@@ -756,41 +784,35 @@
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-alpha.11</version>
<version>1.5.0-alpha.16</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-epub3</artifactId>
<version>1.5.0-alpha.6</version>
<version>1.5.0-alpha.8.1</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>html</id>
<phase>process-resources</phase>
<phase>compile</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>
${project.build.directory}/working
</sourceDirectory>
<sourceDocumentName>index.adoc
</sourceDocumentName>
<sourceDirectory>${generated-asciidoc-sources.directory}</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<backend>html5</backend>
<outputDirectory>
${project.build.directory}/generated-docs
</outputDirectory>
<sectids>false</sectids>
<sourceHighlighter>prettify</sourceHighlighter>
<outputDirectory>${generated-docs.directory}</outputDirectory>
<sourceHighlighter>highlight.js</sourceHighlighter>
<attributes>
<highlightjsdir>js/highlight</highlightjsdir>
<highlightjs-theme>atom-one-dark-reasonable</highlightjs-theme>
<linkcss>true</linkcss>
<icons>font</icons>
<sectanchors>true</sectanchors>
<stylesdir>./stylesheets</stylesdir>
<stylesdir>./css</stylesdir>
<stylesheet>spring.css</stylesheet>
<docinfo>shared</docinfo>
<toc>left</toc>
</attributes>
</configuration>
@@ -798,42 +820,36 @@
<execution>
<id>epub</id>
<phase>generate-resources</phase>
<phase>compile</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>
${project.build.directory}/working
</sourceDirectory>
<sourceDirectory>${generated-asciidoc-sources.directory}</sourceDirectory>
<sourceDocumentName>index.adoc
</sourceDocumentName>
<backend>epub3</backend>
<outputDirectory>
${project.build.directory}/generated-docs
</outputDirectory>
<sectids>false</sectids>
<sourceHighlighter>coderay</sourceHighlighter>
</configuration>
</execution>
<execution>
<id>pdf</id>
<phase>generate-resources</phase>
<phase>compile</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>
${project.build.directory}/working
</sourceDirectory>
<sourceDirectory>${generated-asciidoc-sources.directory}</sourceDirectory>
<sourceDocumentName>index.adoc
</sourceDocumentName>
<backend>pdf</backend>
<outputDirectory>
${project.build.directory}/generated-docs
</outputDirectory>
<sectids>false</sectids>
<sourceHighlighter>coderay</sourceHighlighter>
</configuration>
</execution>
@@ -843,6 +859,11 @@
<configuration>
<doctype>book</doctype>
<attributes>
<doctype>book</doctype>
<docinfo>shared</docinfo>
<icons>font</icons>
<sectids>false</sectids>
<imagesdir>images</imagesdir>
<version>${project.version}</version>
<projectName>${project.name}</projectName>
<projectVersion>${project.version}</projectVersion>

8
src/main/asciidoc/index.adoc
View File

@@ -2,14 +2,6 @@
Mark Paluch;
:revnumber: {version}
:revdate: {localdate}
:linkcss:
:doctype: book
:docinfo: shared
:toc: left
:toclevels: 4
:source-highlighter: prettify
:icons: font
:imagesdir: images
:spring-framework-docs: https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/
:self-docs-root: https://docs.spring.io/spring-vault/docs/{version}/