diff options
author | DeForest Richards <d4m1887@gmail.com> | 2019-10-09 20:26:13 +0000 |
---|---|---|
committer | DeForest Richards <d4m1887@gmail.com> | 2019-10-09 20:26:13 +0000 |
commit | 02d264a54712badfb1886f4b692d51ad0259c0a6 (patch) | |
tree | c3a5d2bec66ae7fb263321ed6a33d71b1eab7a4c | |
parent | 39f759189d51ea32e3010772e4e1409b62aa7ef9 (diff) | |
download | bcm5719-llvm-02d264a54712badfb1886f4b692d51ad0259c0a6.tar.gz bcm5719-llvm-02d264a54712badfb1886f4b692d51ad0259c0a6.zip |
[Docs] Adds Documentation links to sidebar
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
-rw-r--r-- | llvm/docs/GettingStartedTutorials.rst | 6 | ||||
-rw-r--r-- | llvm/docs/Reference.rst | 42 | ||||
-rw-r--r-- | llvm/docs/_templates/indexsidebar.html | 8 |
3 files changed, 34 insertions, 22 deletions
diff --git a/llvm/docs/GettingStartedTutorials.rst b/llvm/docs/GettingStartedTutorials.rst index a8d60343ddc..712463952b8 100644 --- a/llvm/docs/GettingStartedTutorials.rst +++ b/llvm/docs/GettingStartedTutorials.rst @@ -6,6 +6,7 @@ For those new to the LLVM system. .. toctree::
:hidden:
+ CompilerWriterInfo
Frontend/PerformanceTips
GettingStarted
GettingStartedVS
@@ -31,4 +32,7 @@ For those new to the LLVM system. :doc:`GettingStartedVS`
An addendum to the main Getting Started guide for those using Visual Studio
- on Windows.
\ No newline at end of file + on Windows.
+
+:doc:`CompilerWriterInfo`
+ A list of helpful links for compiler writers.
\ No newline at end of file diff --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.rst index a24a8a1eade..c18b6d01375 100644 --- a/llvm/docs/Reference.rst +++ b/llvm/docs/Reference.rst @@ -16,7 +16,6 @@ LLVM and API reference documentation. Bugpoint
CFIVerify
CommandGuide/index
- CompilerWriterInfo
Coroutines
DependenceGraphs/index
ExceptionHandling
@@ -68,23 +67,9 @@ API Reference LLVM Reference
--------------
-:doc:`LLVM Language Reference Manual <LangRef>`
- Defines the LLVM intermediate representation and the assembly form of the
- different nodes.
-
:doc:`FaultMaps`
LLVM support for folding control flow into faulting machine instructions.
-:doc:`InAlloca`
- Description of the ``inalloca`` argument attribute.
-
-:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
- A reference manual for the MIR serialization format, which is used to test
- LLVM's code generation passes.
-
-:doc:`GlobalISel`
- This describes the prototype instruction selection replacement, GlobalISel.
-
:doc:`Atomics`
Information about LLVM's concurrency model.
@@ -92,12 +77,6 @@ LLVM Reference This document describes the design and implementation of exception handling
in LLVM.
-:doc:`CompilerWriterInfo`
- A list of helpful links for compiler writers.
-
-:doc:`BitCodeFormat`
- This describes the file format and encoding used for LLVM "bc" files.
-
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
@@ -198,6 +177,27 @@ LibFuzzer :doc:`FuzzingLLVM`
Information on writing and using Fuzzers to find bugs in LLVM.
+========
+LLVM IR
+========
+
+:doc:`LLVM Language Reference Manual <LangRef>`
+ Defines the LLVM intermediate representation and the assembly form of the
+ different nodes.
+
+:doc:`InAlloca`
+ Description of the ``inalloca`` argument attribute.
+
+:doc:`BitCodeFormat`
+ This describes the file format and encoding used for LLVM "bc" files.
+
+:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
+ A reference manual for the MIR serialization format, which is used to test
+ LLVM's code generation passes.
+
+:doc:`GlobalISel`
+ This describes the prototype instruction selection replacement, GlobalISel.
+
=======
Testing
=======
diff --git a/llvm/docs/_templates/indexsidebar.html b/llvm/docs/_templates/indexsidebar.html index 1a7b7df3ef6..0046f10b21f 100644 --- a/llvm/docs/_templates/indexsidebar.html +++ b/llvm/docs/_templates/indexsidebar.html @@ -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"> |