[Docs] Adds Documentation links to sidebar
authorDeForest Richards <d4m1887@gmail.com>
Wed, 9 Oct 2019 20:26:13 +0000 (20:26 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Wed, 9 Oct 2019 20:26:13 +0000 (20:26 +0000)
Adds links to Getting Started/Tutorials, User Guides, and Reference documentation pages to sidebar. Also adds a new section for LLVM IR on the Reference documentation page.

llvm-svn: 374214

llvm/docs/GettingStartedTutorials.rst
llvm/docs/Reference.rst
llvm/docs/_templates/indexsidebar.html

index a8d6034..7124639 100644 (file)
@@ -6,6 +6,7 @@ For those new to the LLVM system.
 .. toctree::\r
    :hidden:\r
 \r
+   CompilerWriterInfo\r
    Frontend/PerformanceTips\r
    GettingStarted\r
    GettingStartedVS\r
@@ -31,4 +32,7 @@ For those new to the LLVM system.
 \r
 :doc:`GettingStartedVS`\r
    An addendum to the main Getting Started guide for those using Visual Studio\r
-   on Windows.
\ No newline at end of file
+   on Windows.\r
+\r
+:doc:`CompilerWriterInfo`\r
+  A list of helpful links for compiler writers.
\ No newline at end of file
index a24a8a1..c18b6d0 100644 (file)
@@ -16,7 +16,6 @@ LLVM and API reference documentation.
    Bugpoint\r
    CFIVerify\r
    CommandGuide/index\r
-   CompilerWriterInfo\r
    Coroutines\r
    DependenceGraphs/index\r
    ExceptionHandling\r
@@ -68,23 +67,9 @@ API Reference
 LLVM Reference\r
 --------------\r
 \r
-:doc:`LLVM Language Reference Manual <LangRef>`\r
-  Defines the LLVM intermediate representation and the assembly form of the\r
-  different nodes.\r
-\r
 :doc:`FaultMaps`\r
   LLVM support for folding control flow into faulting machine instructions.\r
 \r
-:doc:`InAlloca`\r
-  Description of the ``inalloca`` argument attribute.\r
-\r
-:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`\r
-   A reference manual for the MIR serialization format, which is used to test\r
-   LLVM's code generation passes.\r
-\r
-:doc:`GlobalISel`\r
-  This describes the prototype instruction selection replacement, GlobalISel.\r
-\r
 :doc:`Atomics`\r
   Information about LLVM's concurrency model.\r
 \r
@@ -92,12 +77,6 @@ LLVM Reference
    This document describes the design and implementation of exception handling\r
    in LLVM.\r
 \r
-:doc:`CompilerWriterInfo`\r
-  A list of helpful links for compiler writers.\r
-\r
-:doc:`BitCodeFormat`\r
-   This describes the file format and encoding used for LLVM "bc" files.\r
-\r
 :doc:`Extensions`\r
   LLVM-specific extensions to tools and formats LLVM seeks compatibility with.\r
 \r
@@ -198,6 +177,27 @@ LibFuzzer
 :doc:`FuzzingLLVM`\r
   Information on writing and using Fuzzers to find bugs in LLVM.\r
 \r
+========\r
+LLVM IR\r
+========\r
+\r
+:doc:`LLVM Language Reference Manual <LangRef>`\r
+  Defines the LLVM intermediate representation and the assembly form of the\r
+  different nodes.\r
+\r
+:doc:`InAlloca`\r
+  Description of the ``inalloca`` argument attribute.\r
+\r
+:doc:`BitCodeFormat`\r
+   This describes the file format and encoding used for LLVM "bc" files.\r
+\r
+:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`\r
+   A reference manual for the MIR serialization format, which is used to test\r
+   LLVM's code generation passes.\r
+\r
+:doc:`GlobalISel`\r
+  This describes the prototype instruction selection replacement, GlobalISel.\r
+\r
 =======\r
 Testing\r
 =======\r
index 1a7b7df..0046f10 100644 (file)
@@ -1,6 +1,14 @@
 {# This template defines sidebar which can be used to provide common links on
    all documentation pages. #}
 
+<h3>Documentation</h3>
+
+<ul class="want-points">
+    <li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
+    <li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
+    <li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
+</ul>
+
 <h3>Getting Involved</h3>
 
 <ul class="want-points">