From 9d1e305884da7fc9dbcd612a68896d9d028c282d Mon Sep 17 00:00:00 2001 From: DeForest Richards Date: Thu, 12 Sep 2019 22:17:04 +0000 Subject: [PATCH] [Docs] Adds page for reference docs Adds a Reference Documentation page for LLVM and API reference documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@371782 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/ReferenceDocumentation.rst | 30 ++++++++++++++++++++++++++++++ docs/UserGuides.rst | 9 --------- docs/index.rst | 3 +++ 3 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 docs/ReferenceDocumentation.rst diff --git a/docs/ReferenceDocumentation.rst b/docs/ReferenceDocumentation.rst new file mode 100644 index 00000000000..d72c4978da8 --- /dev/null +++ b/docs/ReferenceDocumentation.rst @@ -0,0 +1,30 @@ +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 1148c4fddec..26ce6f927e2 100644 --- a/docs/UserGuides.rst +++ b/docs/UserGuides.rst @@ -18,7 +18,6 @@ intermediate LLVM representation. HowToBuildWithPGO HowToCrossCompileBuiltinsOnArm HowToCrossCompileLLVM - CommandGuide/index GettingStarted GettingStartedVS FAQ @@ -27,7 +26,6 @@ intermediate LLVM representation. yaml2obj MarkdownQuickstartTemplate Phabricator - TestingGuide tutorial/index ReleaseNotes Passes @@ -73,10 +71,6 @@ intermediate LLVM representation. Tutorials about using LLVM. Includes a tutorial about making a custom language with LLVM. -:doc:`LLVM Command Guide ` - A reference manual for the LLVM command line utilities ("man" pages for LLVM - tools). - :doc:`Passes` A list of optimizations and analyses implemented in LLVM. @@ -86,9 +80,6 @@ intermediate LLVM representation. :doc:`Release notes for the current release ` This describes new features, known bugs, and other limitations. -:doc:`LLVM Testing Infrastructure Guide ` - A reference manual for using the LLVM testing infrastructure. - :doc:`TestSuiteGuide` Describes how to compile and run the test-suite benchmarks. diff --git a/docs/index.rst b/docs/index.rst index 40cadd4af84..944ca8bdfdb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 ========= -- 2.50.1