Skip to content

Commit 1e0cf96

Browse files
committed
Reinstate single page HTML and PDF docs
Closes gh-16854
1 parent e44caec commit 1e0cf96

File tree

9 files changed

+88
-23
lines changed

9 files changed

+88
-23
lines changed

spring-boot-project/spring-boot-docs/pom.xml

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1442,7 +1442,14 @@
14421442
<artifactId>asciidoctor-maven-plugin</artifactId>
14431443
<configuration>
14441444
<sourceDirectory>${refdocs.build.directory}</sourceDirectory>
1445-
<outputDirectory>${project.build.directory}/generated-docs/reference/html</outputDirectory>
1445+
<resources>
1446+
<resource>
1447+
<directory>${refdocs.build.directory}</directory>
1448+
<excludes>
1449+
<exclude>**/*.*adoc</exclude>
1450+
</excludes>
1451+
</resource>
1452+
</resources>
14461453
<attributes>
14471454
<spring-boot-docs-version>${revision}</spring-boot-docs-version>
14481455
<spring-boot-repo>${spring-boot-repo}</spring-boot-repo>
@@ -1465,6 +1472,11 @@
14651472
</goals>
14661473
<configuration>
14671474
<backend>html5</backend>
1475+
<sourceDocumentExtensions>
1476+
<sourceDocumentExtension>adoc</sourceDocumentExtension>
1477+
<sourceDocumentExtension>htmladoc</sourceDocumentExtension>
1478+
</sourceDocumentExtensions>
1479+
<outputDirectory>${project.build.directory}/generated-docs/reference/html</outputDirectory>
14681480
<sourceHighlighter>highlight.js</sourceHighlighter>
14691481
<doctype>book</doctype>
14701482
<attributes>
@@ -1478,6 +1490,53 @@
14781490
</attributes>
14791491
</configuration>
14801492
</execution>
1493+
<execution>
1494+
<id>generate-htmlsingle-documentation</id>
1495+
<phase>prepare-package</phase>
1496+
<goals>
1497+
<goal>process-asciidoc</goal>
1498+
</goals>
1499+
<configuration>
1500+
<backend>html5</backend>
1501+
<sourceDocumentExtensions>
1502+
<sourceDocumentExtension>htmlsingleadoc</sourceDocumentExtension>
1503+
</sourceDocumentExtensions>
1504+
<outputDirectory>${project.build.directory}/generated-docs/reference/htmlsingle</outputDirectory>
1505+
<sourceHighlighter>highlight.js</sourceHighlighter>
1506+
<doctype>book</doctype>
1507+
<attributes>
1508+
<highlightjsdir>js/highlight</highlightjsdir>
1509+
<highlightjs-theme>atom-one-dark-reasonable</highlightjs-theme>
1510+
<linkcss>true</linkcss>
1511+
<imagesdir>./images</imagesdir>
1512+
<icons>font</icons>
1513+
<stylesdir>css/</stylesdir>
1514+
<stylesheet>spring.css</stylesheet>
1515+
</attributes>
1516+
</configuration>
1517+
</execution>
1518+
<execution>
1519+
<id>generate-pdf-documentation</id>
1520+
<phase>prepare-package</phase>
1521+
<goals>
1522+
<goal>process-asciidoc</goal>
1523+
</goals>
1524+
<configuration>
1525+
<backend>pdf</backend>
1526+
<sourceDocumentExtensions>
1527+
<sourceDocumentExtension>pdfadoc</sourceDocumentExtension>
1528+
</sourceDocumentExtensions>
1529+
<outputDirectory>${project.build.directory}/generated-docs/reference/pdf</outputDirectory>
1530+
<resources>
1531+
<resource>
1532+
<directory>${refdocs.build.directory}</directory>
1533+
<excludes>
1534+
<exclude>**/*</exclude>
1535+
</excludes>
1536+
</resource>
1537+
</resources>
1538+
</configuration>
1539+
</execution>
14811540
</executions>
14821541
</plugin>
14831542
<plugin>

spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ as a map for the rest of the document.
1313
[[boot-documentation-about]]
1414
== About the Documentation
1515
The Spring Boot reference guide is available as
16-
<<single-index.adoc#spring-boot-reference-documentation, single page>> or
17-
<<index.adoc#spring-boot-reference-documentation, multi-page>> documentation.
18-
The latest copy
19-
of the reference documentation is available at {spring-boot-docs-current}.
16+
17+
* {spring-boot-docs}/html[Multi-page HTML]
18+
* {spring-boot-docs}/htmlsingle[Single page HTML]
19+
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
20+
21+
The latest copy is available at {spring-boot-docs-current}.
2022

2123
Copies of this document may be made for your own use and for distribution to others,
2224
provided that you do not charge any fee for such copies and further provided that each
Binary file not shown.

spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.svg

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)