diff options
| author | DeForest Richards <d4m1887@gmail.com> | 2019-09-25 00:49:02 +0000 |
|---|---|---|
| committer | DeForest Richards <d4m1887@gmail.com> | 2019-09-25 00:49:02 +0000 |
| commit | ccf6030f7ae9556eae501fb1302a675236030f7e (patch) | |
| tree | 2f1c13a30ff93967879c51f6e413330d8c123210 | |
| parent | 5c4c9e61725526e1e7afca87b395a0efd2aeabfd (diff) | |
| download | bcm5719-llvm-ccf6030f7ae9556eae501fb1302a675236030f7e.tar.gz bcm5719-llvm-ccf6030f7ae9556eae501fb1302a675236030f7e.zip | |
[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
| -rw-r--r-- | llvm/docs/GettingInvolved.rst | 3 | ||||
| -rw-r--r-- | llvm/docs/Reference.rst | 39 | ||||
| -rw-r--r-- | llvm/docs/index.rst | 44 |
3 files changed, 46 insertions, 40 deletions
diff --git a/llvm/docs/GettingInvolved.rst b/llvm/docs/GettingInvolved.rst index 3da4d31ac43..343b226231a 100644 --- a/llvm/docs/GettingInvolved.rst +++ b/llvm/docs/GettingInvolved.rst @@ -3,6 +3,9 @@ Getting Involved LLVM welcomes contributions of all kinds. To get started, please review the following topics:
+.. contents::
+ :local:
+
.. toctree::
:hidden:
diff --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.rst new file mode 100644 index 00000000000..2178eb1bc40 --- /dev/null +++ b/llvm/docs/Reference.rst @@ -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//>`_
+ ..
\ No newline at end of file diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index f029aa70801..4e9bee3c337 100644 --- a/llvm/docs/index.rst +++ b/llvm/docs/index.rst @@ -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 ========= |
