From 87399aedf72e9880a8021d69792d5f8775baf314 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Sat, 19 Sep 2020 14:54:27 +0200 Subject: [PATCH] Do not generate reference docs for include-files Prior to this commit, the Asciidoctor Gradle tasks generated top-level HTML and PDF documents for AsciiDoc files that are included in other top-level documents. This causes slower builds and results in each include-file being published twice: 1) inline in the including document (as intended) 2) as a top-level document but missing surrounding context (unintended) The reason these include-files are generated as top-level documents is that the asciidoctor and asciidoctorPdf Gradle tasks are configured to use '*.adoc' as the input source files. This commit addresses this issue by moving the following include-files to new subdirectories. Locating the include-files in the subdirectories causes them to be ignored in the '*.adoc' pattern used to identify input source files. - data-access-appendix.adoc -> data-access/data-access-appendix.adoc - integration-appendix.adoc -> integration/integration-appendix.adoc - testing-webtestclient.adoc -> testing/testing-webtestclient.adoc Closes gh-25783 --- src/docs/asciidoc/data-access.adoc | 2 +- src/docs/asciidoc/{ => data-access}/data-access-appendix.adoc | 0 src/docs/asciidoc/integration.adoc | 2 +- src/docs/asciidoc/{ => integration}/integration-appendix.adoc | 0 src/docs/asciidoc/testing.adoc | 2 +- src/docs/asciidoc/{ => testing}/testing-webtestclient.adoc | 0 6 files changed, 3 insertions(+), 3 deletions(-) rename src/docs/asciidoc/{ => data-access}/data-access-appendix.adoc (100%) rename src/docs/asciidoc/{ => integration}/integration-appendix.adoc (100%) rename src/docs/asciidoc/{ => testing}/testing-webtestclient.adoc (100%) diff --git a/src/docs/asciidoc/data-access.adoc b/src/docs/asciidoc/data-access.adoc index ef59c4225a8..c831ff3432a 100644 --- a/src/docs/asciidoc/data-access.adoc +++ b/src/docs/asciidoc/data-access.adoc @@ -9022,4 +9022,4 @@ within Web services. -include::data-access-appendix.adoc[leveloffset=+1] +include::data-access/data-access-appendix.adoc[leveloffset=+1] diff --git a/src/docs/asciidoc/data-access-appendix.adoc b/src/docs/asciidoc/data-access/data-access-appendix.adoc similarity index 100% rename from src/docs/asciidoc/data-access-appendix.adoc rename to src/docs/asciidoc/data-access/data-access-appendix.adoc diff --git a/src/docs/asciidoc/integration.adoc b/src/docs/asciidoc/integration.adoc index 1074a1d6ec6..7b1a54a5f95 100644 --- a/src/docs/asciidoc/integration.adoc +++ b/src/docs/asciidoc/integration.adoc @@ -6744,4 +6744,4 @@ directly through the backing cache (when configuring it) or through its native A -include::integration-appendix.adoc[leveloffset=+1] +include::integration/integration-appendix.adoc[leveloffset=+1] diff --git a/src/docs/asciidoc/integration-appendix.adoc b/src/docs/asciidoc/integration/integration-appendix.adoc similarity index 100% rename from src/docs/asciidoc/integration-appendix.adoc rename to src/docs/asciidoc/integration/integration-appendix.adoc diff --git a/src/docs/asciidoc/testing.adoc b/src/docs/asciidoc/testing.adoc index 930ef36a2f4..d91c37ad3de 100644 --- a/src/docs/asciidoc/testing.adoc +++ b/src/docs/asciidoc/testing.adoc @@ -6488,7 +6488,7 @@ of `AbstractTestNGSpringContextTests` for an example of how to instrument your t -include::testing-webtestclient.adoc[leveloffset=+2] +include::testing/testing-webtestclient.adoc[leveloffset=+2] diff --git a/src/docs/asciidoc/testing-webtestclient.adoc b/src/docs/asciidoc/testing/testing-webtestclient.adoc similarity index 100% rename from src/docs/asciidoc/testing-webtestclient.adoc rename to src/docs/asciidoc/testing/testing-webtestclient.adoc