From 9c0825629b715949b7082201bbcd90bfbf9d660b Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Sat, 17 Jul 2021 17:53:43 +0300 Subject: [PATCH] Reintroduce left-hand side navigation in ref docs A side effect of 71995a90876fd5b0aa39259df35476fcc3b0c5ef caused the dynamic table of contents in the left-hand side navigation to no longer be displayed, likely due to the missing "details" DIV. This commit addresses this issue by applying the custom header only to index.adoc. Consequently, the TOC is now displayed again on all pages except the index page, but the customized header is no longer applied to those pages. We may revisit this issue if we decide that we want the custom header on all pages (and not just the index page). Closes gh-27177 --- gradle/docs.gradle | 5 +---- .../{docinfo-header.html => index-docinfo-header.html} | 5 +++++ src/docs/asciidoc/index.adoc | 1 + 3 files changed, 7 insertions(+), 4 deletions(-) rename src/docs/asciidoc/{docinfo-header.html => index-docinfo-header.html} (57%) diff --git a/gradle/docs.gradle b/gradle/docs.gradle index 085d291e07..4b6e139b65 100644 --- a/gradle/docs.gradle +++ b/gradle/docs.gradle @@ -139,7 +139,7 @@ asciidoctorj { icons: 'font', idprefix: '', idseparator: '-', - docinfo: 'shared', + docinfo: 'shared,private-header', // https://docs.asciidoctor.org/asciidoctor/latest/docinfo/ revnumber: project.version, sectanchors: '', sectnums: '', @@ -163,9 +163,6 @@ asciidoctorj { asciidoctor { baseDirFollowsSourceDir() configurations 'asciidoctorExt' - attributes([ - noheader: '' // custom header in docinfo-header.html - ]) sources { include '*.adoc' } diff --git a/src/docs/asciidoc/docinfo-header.html b/src/docs/asciidoc/index-docinfo-header.html similarity index 57% rename from src/docs/asciidoc/docinfo-header.html rename to src/docs/asciidoc/index-docinfo-header.html index 1be13e03b7..485f2e4e98 100644 --- a/src/docs/asciidoc/docinfo-header.html +++ b/src/docs/asciidoc/index-docinfo-header.html @@ -1,4 +1,9 @@ diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index 3df3d0d55e..69a81c4c26 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -1,3 +1,4 @@ +:noheader: = Spring Framework Documentation [horizontal]