[Docs] Moves Reference docs to new page
authorDeForest Richards <d4m1887@gmail.com>
Wed, 25 Sep 2019 00:49:02 +0000 (00:49 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Wed, 25 Sep 2019 00:49:02 +0000 (00:49 +0000)
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

docs/GettingInvolved.rst
docs/Reference.rst [new file with mode: 0644]
docs/index.rst

index 3da4d31ac43b67f37fce5e7d19f0b1dfb5ef7a2f..343b226231ad65a29b650e6236dc333344c6af56 100644 (file)
@@ -3,6 +3,9 @@ Getting Involved
 \r
 LLVM welcomes contributions of all kinds. To get started, please review the following topics:\r
 \r
+.. contents::\r
+   :local:\r
+\r
 .. toctree::\r
    :hidden:\r
 \r
diff --git a/docs/Reference.rst b/docs/Reference.rst
new file mode 100644 (file)
index 0000000..2178eb1
--- /dev/null
@@ -0,0 +1,39 @@
+Reference\r
+=========\r
+\r
+LLVM and API reference documentation.\r
+\r
+.. toctree::\r
+   :hidden:\r
+\r
+   LangRef\r
+   CommandGuide/index\r
+   TestingGuide\r
+   CompilerWriterInfo\r
+   MIRLangRef\r
+\r
+:doc:`LLVM Language Reference Manual <LangRef>`\r
+  Defines the LLVM intermediate representation and the assembly form of the\r
+  different nodes.\r
+\r
+:doc:`LLVM Command Guide <CommandGuide/index>`\r
+   A reference manual for the LLVM command line utilities ("man" pages for LLVM\r
+   tools).\r
+\r
+:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`\r
+   A reference manual for using the LLVM testing infrastructure.\r
+\r
+:doc:`CompilerWriterInfo`\r
+  A list of helpful links for compiler writers.\r
+\r
+:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`\r
+   A reference manual for the MIR serialization format, which is used to test\r
+   LLVM's code generation passes.\r
+\r
+`Doxygen generated documentation <http://llvm.org/doxygen/>`_\r
+  (`classes <http://llvm.org/doxygen/inherits.html>`_)\r
+\r
+`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_\r
+\r
+`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_\r
+   ..
\ No newline at end of file
index f029aa70801f63cecafc2d1ddeea25cfbffb7f52..4e9bee3c33798f9df1a39f3c815f5bb1ffd2a3ff 100644 (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
 =========