[llvm] e6c316e - [Docs] Match body/toctree ordering on Reference and UserGuides (#195542)

via llvm-commits llvm-commits at lists.llvm.org
Sat May 9 16:36:03 PDT 2026


Author: Anshul Nigham
Date: 2026-05-09T23:35:58Z
New Revision: e6c316e374e7380415e7abb15e8816b9027307b1

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

LOG: [Docs] Match body/toctree ordering on Reference and UserGuides (#195542)

The `toctree` section is hidden but used for previous/next breadcrumbs.

This was suggested in
https://github.com/llvm/llvm-project/pull/184440#issuecomment-4351195402

Added: 
    

Modified: 
    llvm/docs/Reference.rst
    llvm/docs/UserGuides.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.rst
index cfbb98b578e76..56e367388b1a8 100644
--- a/llvm/docs/Reference.rst
+++ b/llvm/docs/Reference.rst
@@ -9,61 +9,63 @@ LLVM and API reference documentation.
 .. toctree::
    :hidden:
 
-   AIToolPolicy
-   Atomics
-   BitCodeFormat
-   BlockFrequencyTerminology
-   BranchWeightMetadata
-   CalleeTypeMetadata
-   CallGraphSection
-   CIBestPractices
+   HowToUseAttributes
    CommandGuide/index
-   ContentAddressableStorage
-   ConvergenceAndUniformity
-   ConvergentOperations
-   Coroutines
-   DependenceGraphs/index
-   ExceptionHandling
-   Extensions
-   FaultMaps
-   FuzzingLLVM
+   CommandGuide/llvm-reduce
+   OptBisect
+   SymbolizerMarkupFormat
+   PDB/index
    GarbageCollection
-   GetElementPtr
+   Statepoints
+   LibFuzzer
+   FuzzingLLVM
+   LangRef
+   UndefinedBehavior
+   InAlloca
+   BitCodeFormat
+   MIRLangRef
    GlobalISel/index
+   ConvergentOperations
+   TestingGuide
+   TestSuiteGuide
    GwpAsan
+   XRay
+   XRayExample
+   FaultMaps
+   Atomics
+   ExceptionHandling
+   Extensions
    HowToSetUpLLVMStyleRTTI
-   HowToUseAttributes
-   InAlloca
-   InterfaceExportAnnotations
-   LangRef
-   LibFuzzer
-   MarkedUpDisassembly
-   MIRLangRef
-   OptBisect
-   PCSectionsMetadata
-   PDB/index
-   PointerAuth
-   MLGO
+   BlockFrequencyTerminology
+   BranchWeightMetadata
+   GetElementPtr
    ScudoHardenedAllocator
    MemoryModelRelaxationAnnotations
    MemTagSanitizer
+   DependenceGraphs/index
+   SpeculativeLoadHardening
+   SegmentedStacks
+   MarkedUpDisassembly
+   StackMaps
+   Coroutines
+   PointerAuth
+   YamlIO
+   ConvergenceAndUniformity
+   MLGO
+   ContentAddressableStorage
+   CIBestPractices
+   AIToolPolicy
+   CalleeTypeMetadata
+   CallGraphSection
+   InterfaceExportAnnotations
+   PCSectionsMetadata
    QualGroup
    Security
    SecurityTransparencyReports
-   SegmentedStacks
-   StackMaps
-   SpeculativeLoadHardening
-   Statepoints
-   SymbolizerMarkupFormat
    SystemLibrary
-   TestingGuide
    TransformMetadata
    TypeMetadata
-   UndefinedBehavior
-   XRay
-   XRayExample
    XRayFDRFormat
-   YamlIO
 
 API Reference
 -------------

diff  --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst
index b137ba4dd4830..c4b9293b39ea4 100644
--- a/llvm/docs/UserGuides.rst
+++ b/llvm/docs/UserGuides.rst
@@ -12,79 +12,81 @@ intermediate LLVM representation.
 .. toctree::
    :hidden:
 
-   AArch64SME
-   AddingConstrainedIntrinsics
-   AdminTasks
-   AdvancedBuilds
-   AliasAnalysis
-   AMDGPUUsage
-   AMDGPUAsyncOperations
-   AMDGPUExecutionSynchronization
-   Benchmarking
-   BigEndianNEON
-   BuildingADistribution
+   HowToBuildOnARM
+   HowToBuildWithPGO
+   HowToCrossCompileLLVM
+   CoverageMappingFormat
    CFIVerify
+   BuildingADistribution
    CMake
-   CMakePrimer
-   CodeGenerator
-   CodeOfConduct
-   CommandLine
-   CompileCudaWithLLVM
-   CoverageMappingFormat
-   CycleTerminology
-   DebuggingJITedCode
-   DirectXUsage
    Docker
+   SupportLibrary
+   AdvancedBuilds
+   WritingAnLLVMNewPMPass
+   WritingAnLLVMPass
+   Passes
+   StackSafetyAnalysis
+   MergeFunctions
+   AliasAnalysis
+   MemorySSA
+   MemProf
+   LoopTerminology
+   CycleTerminology
+   Vectorizers
+   LinkTimeOptimization
    DTLTO
-   FatLTO
-   ExtendingLLVM
-   GitHub
    GoldPlugin
-   GlobalISel/MIRPatterns
-   HowToBuildOnARM
-   HowToBuildWithPGO
-   HowToBuildWindowsItaniumPrograms
-   HowToCrossCompileBuiltinsOnArm
-   HowToCrossCompileLLVM
+   Remarks
+   SourceLevelDebugging
    HowToUpdateDebugInfo
-   InstCombineContributorGuide
-   InstrProfileFormat
    InstrRefDebugInfo
+   RemoveDIsDebugInfo
    KeyInstructionsDebugInfo
-   LFI
-   LinkTimeOptimization
-   LoopTerminology
-   MarkdownQuickstartTemplate
-   MemorySSA
-   MemProf
-   MergeFunctions
+   InstrProfileFormat
+   InstCombineContributorGuide
+   WritingAnLLVMBackend
+   CodeGenerator
+   TableGen/index
+   GlobalISel/MIRPatterns
    MCJITDesignAndImplementation
-   MisExpect
    ORCv2
-   OpaquePointers
    JITLink
-   NewPassManager
+   DebuggingJITedCode
+   CommandLine
+   ExtendingLLVM
+   AddingConstrainedIntrinsics
+   HowToBuildWindowsItaniumPrograms
+   HowToCrossCompileBuiltinsOnArm
+   BigEndianNEON
+   AArch64SME
+   CompileCudaWithLLVM
    NVPTXUsage
-   Passes
-   ReportingGuide
-   ResponseGuide
-   Remarks
-   RemoveDIsDebugInfo
+   AMDGPUUsage
+   AMDGPUAsyncOperations
+   AMDGPUDwarfExtensionsForHeterogeneousDebugging
+   AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack
+   AMDGPUExecutionSynchronization
+   SPIRVUsage
+   DirectXUsage
    RISCVUsage
    RISCV/RISCVVectorExtension
    RISCV/RISCVVCIX
-   SourceLevelDebugging
-   SPIRVUsage
    SandboxIR
-   StackSafetyAnalysis
-   SupportLibrary
-   TableGen/index
-   TableGenFundamentals
    Telemetry
-   Vectorizers
-   WritingAnLLVMPass
-   WritingAnLLVMNewPMPass
-   WritingAnLLVMBackend
+   LFI
+   AdminTasks
+   Benchmarking
+   CMakePrimer
+   CodeOfConduct
+   FatLTO
+   GitHub
+   MarkdownQuickstartTemplate
+   MisExpect
+   OpaquePointers
+   NewPassManager
+   ReportingGuide
+   ResponseGuide
+   TableGenFundamentals
    yaml2obj
 
 Clang


        


More information about the llvm-commits mailing list