limit table of contents in guides to depth of 2 (#11166)

* limit table of contents in guides to depth of 2 * typo #11166 * add link to PR #11166
IQSS · Feb 11, 2025 · f4380ea · f4380ea
1 parent 106fb6f
commit f4380ea
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 2 deletions.
diff --git a/doc/release-notes/guides-toc-depth.md 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
@@ -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
@@ -9,6 +9,7 @@ API Guide
 **Contents:**
 
 .. toctree::
+   :maxdepth: 2
 
    intro
    getting-started
@@ -24,4 +25,4 @@ API Guide
    linkeddatanotification
    apps
    faq
-   changelog
+   changelog
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -9,6 +9,7 @@ User Guide
 **Contents:**
 
 .. toctree::
+   :maxdepth: 2
 
    account
    find-use-data
Original file line number	Diff line number	Diff line change
		@@ -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.
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ Installation Guide @@
     **Contents:**
     .. toctree::
+       :maxdepth: 2
        intro
        prep
@@ Expand Down @@