Skip to content

Commit ccf6030

Browse files
committed
[Docs] Moves Reference docs to new page
Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
1 parent 5c4c9e6 commit ccf6030

File tree

3 files changed

+46
-40
lines changed

3 files changed

+46
-40
lines changed

llvm/docs/GettingInvolved.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ Getting Involved
33

44
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
55

6+
.. contents::
7+
:local:
8+
69
.. toctree::
710
:hidden:
811

llvm/docs/Reference.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Reference
2+
=========
3+
4+
LLVM and API reference documentation.
5+
6+
.. toctree::
7+
:hidden:
8+
9+
LangRef
10+
CommandGuide/index
11+
TestingGuide
12+
CompilerWriterInfo
13+
MIRLangRef
14+
15+
:doc:`LLVM Language Reference Manual <LangRef>`
16+
Defines the LLVM intermediate representation and the assembly form of the
17+
different nodes.
18+
19+
:doc:`LLVM Command Guide <CommandGuide/index>`
20+
A reference manual for the LLVM command line utilities ("man" pages for LLVM
21+
tools).
22+
23+
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
24+
A reference manual for using the LLVM testing infrastructure.
25+
26+
:doc:`CompilerWriterInfo`
27+
A list of helpful links for compiler writers.
28+
29+
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
30+
A reference manual for the MIR serialization format, which is used to test
31+
LLVM's code generation passes.
32+
33+
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
34+
(`classes <http://llvm.org/doxygen/inherits.html>`_)
35+
36+
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
37+
38+
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
39+
..

llvm/docs/index.rst

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
5858

5959
UserGuides
6060
ProgrammingDocumentation
61+
Reference
6162
SubsystemDocumentation
6263

6364
:doc:`UserGuides`
@@ -69,6 +70,9 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
6970
:doc:`SubsystemDocumentation`
7071
For API clients and LLVM developers.
7172

73+
:doc:`Reference`
74+
LLVM and API reference documentation.
75+
7276
Getting Started/Tutorials
7377
-------------------------
7478

@@ -92,46 +96,6 @@ Getting Started/Tutorials
9296
An addendum to the main Getting Started guide for those using Visual Studio
9397
on Windows.
9498

95-
Reference
96-
---------
97-
98-
LLVM and API reference documentation.
99-
100-
.. toctree::
101-
:hidden:
102-
103-
LangRef
104-
CommandGuide/index
105-
TestingGuide
106-
CompilerWriterInfo
107-
MIRLangRef
108-
109-
:doc:`LLVM Language Reference Manual <LangRef>`
110-
Defines the LLVM intermediate representation and the assembly form of the
111-
different nodes.
112-
113-
:doc:`LLVM Command Guide <CommandGuide/index>`
114-
A reference manual for the LLVM command line utilities ("man" pages for LLVM
115-
tools).
116-
117-
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
118-
A reference manual for using the LLVM testing infrastructure.
119-
120-
:doc:`CompilerWriterInfo`
121-
A list of helpful links for compiler writers.
122-
123-
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
124-
A reference manual for the MIR serialization format, which is used to test
125-
LLVM's code generation passes.
126-
127-
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
128-
(`classes <http://llvm.org/doxygen/inherits.html>`_)
129-
130-
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
131-
132-
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
133-
..
134-
13599
Community
136100
=========
137101

0 commit comments

Comments
 (0)