Commit 1e0cf960 authored by Phillip Webb's avatar Phillip Webb

Reinstate single page HTML and PDF docs

Closes gh-16854
parent e44caec6
...@@ -1442,7 +1442,14 @@ ...@@ -1442,7 +1442,14 @@
<artifactId>asciidoctor-maven-plugin</artifactId> <artifactId>asciidoctor-maven-plugin</artifactId>
<configuration> <configuration>
<sourceDirectory>${refdocs.build.directory}</sourceDirectory> <sourceDirectory>${refdocs.build.directory}</sourceDirectory>
<outputDirectory>${project.build.directory}/generated-docs/reference/html</outputDirectory> <resources>
<resource>
<directory>${refdocs.build.directory}</directory>
<excludes>
<exclude>**/*.*adoc</exclude>
</excludes>
</resource>
</resources>
<attributes> <attributes>
<spring-boot-docs-version>${revision}</spring-boot-docs-version> <spring-boot-docs-version>${revision}</spring-boot-docs-version>
<spring-boot-repo>${spring-boot-repo}</spring-boot-repo> <spring-boot-repo>${spring-boot-repo}</spring-boot-repo>
...@@ -1465,6 +1472,11 @@ ...@@ -1465,6 +1472,11 @@
</goals> </goals>
<configuration> <configuration>
<backend>html5</backend> <backend>html5</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>adoc</sourceDocumentExtension>
<sourceDocumentExtension>htmladoc</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>${project.build.directory}/generated-docs/reference/html</outputDirectory>
<sourceHighlighter>highlight.js</sourceHighlighter> <sourceHighlighter>highlight.js</sourceHighlighter>
<doctype>book</doctype> <doctype>book</doctype>
<attributes> <attributes>
...@@ -1478,6 +1490,53 @@ ...@@ -1478,6 +1490,53 @@
</attributes> </attributes>
</configuration> </configuration>
</execution> </execution>
<execution>
<id>generate-htmlsingle-documentation</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>htmlsingleadoc</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>${project.build.directory}/generated-docs/reference/htmlsingle</outputDirectory>
<sourceHighlighter>highlight.js</sourceHighlighter>
<doctype>book</doctype>
<attributes>
<highlightjsdir>js/highlight</highlightjsdir>
<highlightjs-theme>atom-one-dark-reasonable</highlightjs-theme>
<linkcss>true</linkcss>
<imagesdir>./images</imagesdir>
<icons>font</icons>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
</attributes>
</configuration>
</execution>
<execution>
<id>generate-pdf-documentation</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>pdf</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>pdfadoc</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>${project.build.directory}/generated-docs/reference/pdf</outputDirectory>
<resources>
<resource>
<directory>${refdocs.build.directory}</directory>
<excludes>
<exclude>**/*</exclude>
</excludes>
</resource>
</resources>
</configuration>
</execution>
</executions> </executions>
</plugin> </plugin>
<plugin> <plugin>
......
...@@ -13,10 +13,12 @@ as a map for the rest of the document. ...@@ -13,10 +13,12 @@ as a map for the rest of the document.
[[boot-documentation-about]] [[boot-documentation-about]]
== About the Documentation == About the Documentation
The Spring Boot reference guide is available as The Spring Boot reference guide is available as
<<single-index.adoc#spring-boot-reference-documentation, single page>> or
<<index.adoc#spring-boot-reference-documentation, multi-page>> documentation. * {spring-boot-docs}/html[Multi-page HTML]
The latest copy * {spring-boot-docs}/htmlsingle[Single page HTML]
of the reference documentation is available at {spring-boot-docs-current}. * {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
The latest copy is available at {spring-boot-docs-current}.
Copies of this document may be made for your own use and for distribution to others, 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 provided that you do not charge any fee for such copies and further provided that each
......
[[spring-boot-reference-documentation]]
= Spring Boot Reference Documentation
Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons, Vedran Pavić, Jay Bryant, Madhura Bhave
:docinfo: shared
include::attributes.adoc[]
include::legal.adoc[leveloffset=+1]
include::documentation-overview.adoc[leveloffset=+1]
include::getting-started.adoc[leveloffset=+1]
include::using-spring-boot.adoc[leveloffset=+1]
include::spring-boot-features.adoc[leveloffset=+1]
include::production-ready-features.adoc[leveloffset=+1]
include::deployment.adoc[leveloffset=+1]
include::spring-boot-cli.adoc[leveloffset=+1]
include::build-tool-plugins.adoc[leveloffset=+1]
include::howto.adoc[leveloffset=+1]
include::appendix.adoc[leveloffset=+1]
...@@ -306,6 +306,11 @@ ...@@ -306,6 +306,11 @@
<artifactId>asciidoctorj</artifactId> <artifactId>asciidoctorj</artifactId>
<version>1.5.8</version> <version>1.5.8</version>
</dependency> </dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-alpha.11</version>
</dependency>
</dependencies> </dependencies>
</plugin> </plugin>
<plugin> <plugin>
......
...@@ -356,11 +356,6 @@ ...@@ -356,11 +356,6 @@
</attributes> </attributes>
</configuration> </configuration>
<dependencies> <dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-alpha.11</version>
</dependency>
<dependency> <dependency>
<groupId>io.spring.asciidoctor</groupId> <groupId>io.spring.asciidoctor</groupId>
<artifactId>spring-asciidoctor-extensions</artifactId> <artifactId>spring-asciidoctor-extensions</artifactId>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment