[llvm] fe07161 - [LangRef] Reduce depth of table of contents

[Jay Foad via llvm-commits]

Author: Jay Foad
Date: 2022-07-29T21:15:00+01:00
New Revision: fe07161a181e39fb734a4da87ea21b19b2c4e6bb

URL: https://github.com/llvm/llvm-project/commit/fe07161a181e39fb734a4da87ea21b19b2c4e6bb
DIFF: https://github.com/llvm/llvm-project/commit/fe07161a181e39fb734a4da87ea21b19b2c4e6bb.diff

LOG: [LangRef] Reduce depth of table of contents

The table of contents in the HTML version of this doc takes up 25 pages
(in my browser, on my 4K monitor) and is too long for me to navigate
comfortably. And most of it is irrelevant detail like this:

- Bitwise Binary Operations
  - 'shl' Instruction
    - Syntax:
    - Overview:
    - Arguments:
    - Semantics:
    - Example:
  - 'lshr' Instruction
    - Syntax:
    - Overview:
    - Arguments:
    - Semantics:
    - Example:

Reducing the contents depth from 4 to 3 removes most of this detail,
leaving just a list of instructions, which only takes up 7 pages and I
find it much easier to navigate.

Incidentally the depth was set to 3 when this document was first
converted to reST and was only increased to 4 in what looks like an
accidental change: 080133453bae62a43466e881ffc03fb7cffd7288

Differential Revision: https://reviews.llvm.org/D130635

Added: 
    

Modified: 
    llvm/docs/LangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index bc1f63f272f3d..28d4121dd054e 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -4,7 +4,7 @@ LLVM Language Reference Manual
 
 .. contents::
    :local:
-   :depth: 4
+   :depth: 3
 
 Abstract
 ========