diff --git a/doc/release-notes/guides-toc-depth.md b/doc/release-notes/guides-toc-depth.md new file mode 100644 index 00000000000..0f5dd39186f --- /dev/null +++ b/doc/release-notes/guides-toc-depth.md @@ -0,0 +1,3 @@ +### Guides Table of Contents Depth + +On the home page for each guide (User Guide, etc.) there was an overwhelming amount of information in the form of a deeply nested tabled of contents. The depth of the table of contents has been reduced to two levels, making the home page for each guide more readable. See #11166. diff --git a/doc/sphinx-guides/source/admin/index.rst b/doc/sphinx-guides/source/admin/index.rst index 633842044b4..bada3ea20b4 100755 --- a/doc/sphinx-guides/source/admin/index.rst +++ b/doc/sphinx-guides/source/admin/index.rst @@ -11,6 +11,7 @@ This guide documents the functionality only available to superusers (such as "da **Contents:** .. toctree:: + :maxdepth: 2 dashboard external-tools diff --git a/doc/sphinx-guides/source/api/index.rst b/doc/sphinx-guides/source/api/index.rst index dd195aa9d62..5ff7626271d 100755 --- a/doc/sphinx-guides/source/api/index.rst +++ b/doc/sphinx-guides/source/api/index.rst @@ -9,6 +9,7 @@ API Guide **Contents:** .. toctree:: + :maxdepth: 2 intro getting-started @@ -24,4 +25,4 @@ API Guide linkeddatanotification apps faq - changelog \ No newline at end of file + changelog diff --git a/doc/sphinx-guides/source/container/index.rst b/doc/sphinx-guides/source/container/index.rst index abf871dd340..38641cce642 100644 --- a/doc/sphinx-guides/source/container/index.rst +++ b/doc/sphinx-guides/source/container/index.rst @@ -4,6 +4,7 @@ Container Guide **Contents:** .. toctree:: + :maxdepth: 2 intro running/index diff --git a/doc/sphinx-guides/source/contributor/index.md b/doc/sphinx-guides/source/contributor/index.md index 1017f15f0ed..f7979b1dd0c 100644 --- a/doc/sphinx-guides/source/contributor/index.md +++ b/doc/sphinx-guides/source/contributor/index.md @@ -4,7 +4,7 @@ Thank you for your interest in contributing to Dataverse! We are open to contri ```{contents} Contents: :local: -:depth: 3 +:depth: 2 ``` ## Ideas and Feature Requests diff --git a/doc/sphinx-guides/source/developers/index.rst b/doc/sphinx-guides/source/developers/index.rst index 6d01e13d78e..90ccc261b1d 100755 --- a/doc/sphinx-guides/source/developers/index.rst +++ b/doc/sphinx-guides/source/developers/index.rst @@ -9,6 +9,7 @@ Developer Guide **Contents:** .. toctree:: + :maxdepth: 2 intro dev-environment diff --git a/doc/sphinx-guides/source/installation/index.rst b/doc/sphinx-guides/source/installation/index.rst index 1965448aedb..e9abc176d6a 100755 --- a/doc/sphinx-guides/source/installation/index.rst +++ b/doc/sphinx-guides/source/installation/index.rst @@ -9,6 +9,7 @@ Installation Guide **Contents:** .. toctree:: + :maxdepth: 2 intro prep diff --git a/doc/sphinx-guides/source/qa/index.md b/doc/sphinx-guides/source/qa/index.md index f16cd1d38fc..623b93ef31b 100644 --- a/doc/sphinx-guides/source/qa/index.md +++ b/doc/sphinx-guides/source/qa/index.md @@ -1,6 +1,8 @@ # QA Guide ```{toctree} +:caption: "Contents:" +:maxdepth: 2 overview.md testing-approach.md testing-infrastructure.md diff --git a/doc/sphinx-guides/source/style/index.rst b/doc/sphinx-guides/source/style/index.rst index 0e93716e146..65a9f0b2b55 100755 --- a/doc/sphinx-guides/source/style/index.rst +++ b/doc/sphinx-guides/source/style/index.rst @@ -11,6 +11,7 @@ This style guide is meant to help developers implement clear and appropriate UI **Contents:** .. toctree:: + :maxdepth: 2 foundations patterns diff --git a/doc/sphinx-guides/source/user/index.rst b/doc/sphinx-guides/source/user/index.rst index 857bd27ca22..cd6ccdbd421 100755 --- a/doc/sphinx-guides/source/user/index.rst +++ b/doc/sphinx-guides/source/user/index.rst @@ -9,6 +9,7 @@ User Guide **Contents:** .. toctree:: + :maxdepth: 2 account find-use-data