[PATCH] D130635: [LangRef] Reduce depth of table of contents

Jay Foad via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Jul 27 07:19:37 PDT 2022


foad created this revision.
Herald added a subscriber: jdoerfert.
Herald added a project: All.
foad requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

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


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D130635

Files:
  llvm/docs/LangRef.rst


Index: llvm/docs/LangRef.rst
===================================================================
--- llvm/docs/LangRef.rst
+++ llvm/docs/LangRef.rst
@@ -4,7 +4,7 @@
 
 .. contents::
    :local:
-   :depth: 4
+   :depth: 3
 
 Abstract
 ========


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D130635.448031.patch
Type: text/x-patch
Size: 244 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220727/180e92e9/attachment.bin>


More information about the llvm-commits mailing list