RPCS3/llvm
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm.git synced 2024-11-23 19:59:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Docs] Moves Reference docs to new page

Browse Source 
Moves Reference docs to new page. Also adds a table of contents to Getting Involved page.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@372796 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
DeForest Richards 2019-09-25 00:49:02 +00:00
parent 3824944743
commit 3ab1cbcab3
3 changed files with 46 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/GettingInvolved.rst
View File

@ -3,6 +3,9 @@ Getting Involved
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
.. contents::
:local:
.. toctree::
:hidden:

39
docs/Reference.rst Normal file
View File

@ -0,0 +1,39 @@
Reference
=========
LLVM and API reference documentation.
.. toctree::
:hidden:
LangRef
CommandGuide/index
TestingGuide
CompilerWriterInfo
MIRLangRef
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`LLVM Command Guide <CommandGuide/index>`
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
A reference manual for using the LLVM testing infrastructure.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
: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.
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
..

44
docs/index.rst
View File

@ -58,6 +58,7 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
UserGuides
ProgrammingDocumentation
Reference
SubsystemDocumentation
:doc:`UserGuides`
@ -69,6 +70,9 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
:doc:`SubsystemDocumentation`
For API clients and LLVM developers.
:doc:`Reference`
LLVM and API reference documentation.
Getting Started/Tutorials
-------------------------
@ -92,46 +96,6 @@ Getting Started/Tutorials
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
Reference
---------
LLVM and API reference documentation.
.. toctree::
:hidden:
LangRef
CommandGuide/index
TestingGuide
CompilerWriterInfo
MIRLangRef
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`LLVM Command Guide <CommandGuide/index>`
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
A reference manual for using the LLVM testing infrastructure.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
: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.
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
..
Community
=========