]> granicus.if.org Git - llvm/commitdiff
[Docs] Adds Getting Started/Tutorials, Reference to LLVM docs homepage
authorDeForest Richards <d4m1887@gmail.com>
Mon, 16 Sep 2019 20:19:32 +0000 (20:19 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Mon, 16 Sep 2019 20:19:32 +0000 (20:19 +0000)
Adds a section for Getting Started/Tutorials and Reference topics to the LLVM docs homepage.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@372031 91177308-0d34-0410-b5e6-96231b3b80d8

docs/ReferenceDocumentation.rst [deleted file]
docs/UserGuides.rst
docs/index.rst

diff --git a/docs/ReferenceDocumentation.rst b/docs/ReferenceDocumentation.rst
deleted file mode 100644 (file)
index d72c497..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-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 26ce6f927e2d72315ab6ddf94a128d506cfef6ba..65c7d5e83c3dfe6617d7d93e99826c87c8b58106 100644 (file)
@@ -18,16 +18,12 @@ intermediate LLVM representation.
    HowToBuildWithPGO\r
    HowToCrossCompileBuiltinsOnArm\r
    HowToCrossCompileLLVM\r
-   GettingStarted\r
    GettingStartedVS\r
    FAQ\r
-   Lexicon\r
    HowToAddABuilder\r
    yaml2obj\r
    MarkdownQuickstartTemplate\r
    Phabricator\r
-   tutorial/index\r
-   ReleaseNotes\r
    Passes\r
    YamlIO\r
    GetElementPtr\r
@@ -42,11 +38,6 @@ intermediate LLVM representation.
    BuildingADistribution\r
    Remarks\r
 \r
-:doc:`GettingStarted`\r
-   Discusses how to get up and running quickly with the LLVM infrastructure.\r
-   Everything from unpacking and compilation of the distribution to execution\r
-   of some tools.\r
-\r
 :doc:`CMake`\r
    An addendum to the main Getting Started guide for those using the `CMake\r
    build system <http://www.cmake.org>`_.\r
@@ -67,19 +58,12 @@ intermediate LLVM representation.
    An addendum to the main Getting Started guide for those using Visual Studio\r
    on Windows.\r
 \r
-:doc:`tutorial/index`\r
-   Tutorials about using LLVM. Includes a tutorial about making a custom\r
-   language with LLVM.\r
-\r
 :doc:`Passes`\r
    A list of optimizations and analyses implemented in LLVM.\r
 \r
 :doc:`FAQ`\r
    A list of common questions and problems and their solutions.\r
 \r
-:doc:`Release notes for the current release <ReleaseNotes>`\r
-   This describes new features, known bugs, and other limitations.\r
-\r
 :doc:`TestSuiteGuide`\r
   Describes how to compile and run the test-suite benchmarks.\r
 \r
@@ -88,9 +72,6 @@ intermediate LLVM representation.
 \r
    .. __: http://clang.llvm.org/get_started.html\r
 \r
-:doc:`Lexicon`\r
-   Definition of acronyms, terms and concepts used in LLVM.\r
-\r
 :doc:`HowToAddABuilder`\r
    Instructions for adding new builder to LLVM buildbot master.\r
 \r
index 6b0d803a86a18c231c6b4e0c0b5fb1916b0234b3..7388174b0233d792fecb2ddfc5e219daedd50d1e 100644 (file)
@@ -22,6 +22,7 @@ Several introductory papers and presentations.
    :hidden:
 
    LangRef
+   Lexicon
 
 :doc:`LangRef`
   Defines the LLVM intermediate representation.
@@ -50,6 +51,9 @@ Several introductory papers and presentations.
 `Publications mentioning LLVM <http://llvm.org/pubs>`_
    ..
 
+:doc:`Lexicon`
+   Definition of acronyms, terms and concepts used in LLVM.
+
 Documentation
 =============
 
@@ -63,7 +67,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
    SubsystemDocumentation
    ReferenceDocumentation
 
-
 :doc:`UserGuides`
   For those new to the LLVM system.
 
@@ -73,8 +76,56 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
 :doc:`SubsystemDocumentation`
   For API clients and LLVM developers.
 
-:doc:`ReferenceDocumentation`
-  LLVM and API reference documentation.
+Getting Started/Tutorials
+-------------------------
+
+.. toctree::
+   :hidden:
+
+   GettingStarted
+   tutorial/index
+
+:doc:`GettingStarted`
+   Discusses how to get up and running quickly with the LLVM infrastructure.
+   Everything from unpacking and compilation of the distribution to execution
+   of some tools.
+
+:doc:`tutorial/index`
+   Tutorials about using LLVM. Includes a tutorial about making a custom
+   language with LLVM.
+
+Reference
+---------
+
+.. toctree::
+   :hidden:
+
+LLVM and API reference documentation.
+
+.. toctree::
+   :hidden:
+
+   CommandGuide/index
+   TestingGuide
+
+: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.
+
+`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
 =========
@@ -132,6 +183,7 @@ Information about LLVM's development process.
    HowToReleaseLLVM
    Packaging
    ReleaseProcess
+   ReleaseNotes
 
 :doc:`Projects`
   How-to guide and templates for new projects that *use* the LLVM
@@ -152,6 +204,9 @@ Information about LLVM's development process.
 :doc:`Packaging`
    Advice on packaging LLVM into a distribution.
 
+:doc:`Release notes for the current release <ReleaseNotes>`
+   This describes new features, known bugs, and other limitations.
+
 Mailing Lists
 -------------