[Docs] Adds page for reference docs
authorDeForest Richards <d4m1887@gmail.com>
Thu, 12 Sep 2019 22:17:04 +0000 (22:17 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Thu, 12 Sep 2019 22:17:04 +0000 (22:17 +0000)
Adds a Reference Documentation page for LLVM and API reference documentation.

llvm-svn: 371782

llvm/docs/ReferenceDocumentation.rst [new file with mode: 0644]
llvm/docs/UserGuides.rst
llvm/docs/index.rst

diff --git a/llvm/docs/ReferenceDocumentation.rst b/llvm/docs/ReferenceDocumentation.rst
new file mode 100644 (file)
index 0000000..d72c497
--- /dev/null
@@ -0,0 +1,30 @@
+Reference Documentation\r
+========================\r
+\r
+LLVM and API reference documentation.\r
+\r
+.. toctree::\r
+   :hidden:\r
+\r
+   CommandGuide/index\r
+   TestingGuide\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
+`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
+   ..\r
+\r
index 1148c4f..26ce6f9 100644 (file)
@@ -18,7 +18,6 @@ intermediate LLVM representation.
    HowToBuildWithPGO\r
    HowToCrossCompileBuiltinsOnArm\r
    HowToCrossCompileLLVM\r
-   CommandGuide/index\r
    GettingStarted\r
    GettingStartedVS\r
    FAQ\r
@@ -27,7 +26,6 @@ intermediate LLVM representation.
    yaml2obj\r
    MarkdownQuickstartTemplate\r
    Phabricator\r
-   TestingGuide\r
    tutorial/index\r
    ReleaseNotes\r
    Passes\r
@@ -73,10 +71,6 @@ intermediate LLVM representation.
    Tutorials about using LLVM. Includes a tutorial about making a custom\r
    language with LLVM.\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:`Passes`\r
    A list of optimizations and analyses implemented in LLVM.\r
 \r
@@ -86,9 +80,6 @@ intermediate LLVM representation.
 :doc:`Release notes for the current release <ReleaseNotes>`\r
    This describes new features, known bugs, and other limitations.\r
 \r
-:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`\r
-   A reference manual for using the LLVM testing infrastructure.\r
-\r
 :doc:`TestSuiteGuide`\r
   Describes how to compile and run the test-suite benchmarks.\r
 \r
index 40cadd4..944ca8b 100644 (file)
@@ -71,6 +71,9 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
 :doc:`SubsystemDocumentation`
   For API clients and LLVM developers.
 
+:doc:`ReferenceDocumentation`
+  LLVM and API reference documentation.
+
 Community
 =========