Skip to content

Commit 02d264a

Browse files
committed
[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
1 parent 39f7591 commit 02d264a

File tree

3 files changed

+34
-22
lines changed

3 files changed

+34
-22
lines changed

llvm/docs/GettingStartedTutorials.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ For those new to the LLVM system.
66
.. toctree::
77
:hidden:
88

9+
CompilerWriterInfo
910
Frontend/PerformanceTips
1011
GettingStarted
1112
GettingStartedVS
@@ -31,4 +32,7 @@ For those new to the LLVM system.
3132

3233
:doc:`GettingStartedVS`
3334
An addendum to the main Getting Started guide for those using Visual Studio
34-
on Windows.
35+
on Windows.
36+
37+
:doc:`CompilerWriterInfo`
38+
A list of helpful links for compiler writers.

llvm/docs/Reference.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ LLVM and API reference documentation.
1616
Bugpoint
1717
CFIVerify
1818
CommandGuide/index
19-
CompilerWriterInfo
2019
Coroutines
2120
DependenceGraphs/index
2221
ExceptionHandling
@@ -68,36 +67,16 @@ API Reference
6867
LLVM Reference
6968
--------------
7069

71-
:doc:`LLVM Language Reference Manual <LangRef>`
72-
Defines the LLVM intermediate representation and the assembly form of the
73-
different nodes.
74-
7570
:doc:`FaultMaps`
7671
LLVM support for folding control flow into faulting machine instructions.
7772

78-
:doc:`InAlloca`
79-
Description of the ``inalloca`` argument attribute.
80-
81-
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
82-
A reference manual for the MIR serialization format, which is used to test
83-
LLVM's code generation passes.
84-
85-
:doc:`GlobalISel`
86-
This describes the prototype instruction selection replacement, GlobalISel.
87-
8873
:doc:`Atomics`
8974
Information about LLVM's concurrency model.
9075

9176
:doc:`ExceptionHandling`
9277
This document describes the design and implementation of exception handling
9378
in LLVM.
9479

95-
:doc:`CompilerWriterInfo`
96-
A list of helpful links for compiler writers.
97-
98-
:doc:`BitCodeFormat`
99-
This describes the file format and encoding used for LLVM "bc" files.
100-
10180
:doc:`Extensions`
10281
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
10382

@@ -198,6 +177,27 @@ LibFuzzer
198177
:doc:`FuzzingLLVM`
199178
Information on writing and using Fuzzers to find bugs in LLVM.
200179

180+
========
181+
LLVM IR
182+
========
183+
184+
:doc:`LLVM Language Reference Manual <LangRef>`
185+
Defines the LLVM intermediate representation and the assembly form of the
186+
different nodes.
187+
188+
:doc:`InAlloca`
189+
Description of the ``inalloca`` argument attribute.
190+
191+
:doc:`BitCodeFormat`
192+
This describes the file format and encoding used for LLVM "bc" files.
193+
194+
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
195+
A reference manual for the MIR serialization format, which is used to test
196+
LLVM's code generation passes.
197+
198+
:doc:`GlobalISel`
199+
This describes the prototype instruction selection replacement, GlobalISel.
200+
201201
=======
202202
Testing
203203
=======

llvm/docs/_templates/indexsidebar.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
{# This template defines sidebar which can be used to provide common links on
22
all documentation pages. #}
33

4+
<h3>Documentation</h3>
5+
6+
<ul class="want-points">
7+
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
8+
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
9+
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
10+
</ul>
11+
412
<h3>Getting Involved</h3>
513

614
<ul class="want-points">

0 commit comments

Comments
 (0)