From: DeForest Richards Date: Mon, 16 Sep 2019 20:19:32 +0000 (+0000) Subject: [Docs] Adds Getting Started/Tutorials, Reference to LLVM docs homepage X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=09c2c6f7b221e5bcacdd9ee6753fc3ba728ba131;p=llvm [Docs] Adds Getting Started/Tutorials, Reference to LLVM docs homepage 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 --- diff --git a/docs/ReferenceDocumentation.rst b/docs/ReferenceDocumentation.rst deleted file mode 100644 index d72c4978da8..00000000000 --- a/docs/ReferenceDocumentation.rst +++ /dev/null @@ -1,30 +0,0 @@ -Reference Documentation -======================== - -LLVM and API reference documentation. - -.. toctree:: - :hidden: - - CommandGuide/index - TestingGuide - -:doc:`LLVM Language Reference Manual ` - Defines the LLVM intermediate representation and the assembly form of the - different nodes. - -:doc:`LLVM Command Guide ` - A reference manual for the LLVM command line utilities ("man" pages for LLVM - tools). - -:doc:`LLVM Testing Infrastructure Guide ` - A reference manual for using the LLVM testing infrastructure. - -`Doxygen generated documentation `_ - (`classes `_) - -`Documentation for Go bindings `_ - -`Github Source Repository Browser `_ - .. - diff --git a/docs/UserGuides.rst b/docs/UserGuides.rst index 26ce6f927e2..65c7d5e83c3 100644 --- a/docs/UserGuides.rst +++ b/docs/UserGuides.rst @@ -18,16 +18,12 @@ intermediate LLVM representation. HowToBuildWithPGO HowToCrossCompileBuiltinsOnArm HowToCrossCompileLLVM - GettingStarted GettingStartedVS FAQ - Lexicon HowToAddABuilder yaml2obj MarkdownQuickstartTemplate Phabricator - tutorial/index - ReleaseNotes Passes YamlIO GetElementPtr @@ -42,11 +38,6 @@ intermediate LLVM representation. BuildingADistribution Remarks -: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:`CMake` An addendum to the main Getting Started guide for those using the `CMake build system `_. @@ -67,19 +58,12 @@ intermediate LLVM representation. An addendum to the main Getting Started guide for those using Visual Studio on Windows. -:doc:`tutorial/index` - Tutorials about using LLVM. Includes a tutorial about making a custom - language with LLVM. - :doc:`Passes` A list of optimizations and analyses implemented in LLVM. :doc:`FAQ` A list of common questions and problems and their solutions. -:doc:`Release notes for the current release ` - This describes new features, known bugs, and other limitations. - :doc:`TestSuiteGuide` Describes how to compile and run the test-suite benchmarks. @@ -88,9 +72,6 @@ intermediate LLVM representation. .. __: http://clang.llvm.org/get_started.html -:doc:`Lexicon` - Definition of acronyms, terms and concepts used in LLVM. - :doc:`HowToAddABuilder` Instructions for adding new builder to LLVM buildbot master. diff --git a/docs/index.rst b/docs/index.rst index 6b0d803a86a..7388174b023 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_ .. +: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 ` + Defines the LLVM intermediate representation and the assembly form of the + different nodes. + +:doc:`LLVM Command Guide ` + A reference manual for the LLVM command line utilities ("man" pages for LLVM + tools). + +:doc:`LLVM Testing Infrastructure Guide ` + A reference manual for using the LLVM testing infrastructure. + +`Doxygen generated documentation `_ + (`classes `_) + +`Documentation for Go bindings `_ + +`Github Source Repository Browser `_ + .. 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 ` + This describes new features, known bugs, and other limitations. + Mailing Lists -------------