diff options
| -rw-r--r-- | llvm/docs/ReferenceDocumentation.rst | 30 | ||||
| -rw-r--r-- | llvm/docs/UserGuides.rst | 9 | ||||
| -rw-r--r-- | llvm/docs/index.rst | 3 |
3 files changed, 33 insertions, 9 deletions
diff --git a/llvm/docs/ReferenceDocumentation.rst b/llvm/docs/ReferenceDocumentation.rst new file mode 100644 index 00000000000..d72c4978da8 --- /dev/null +++ b/llvm/docs/ReferenceDocumentation.rst @@ -0,0 +1,30 @@ +Reference Documentation
+========================
+
+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//>`_
+ ..
+
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst index 1148c4fddec..26ce6f927e2 100644 --- a/llvm/docs/UserGuides.rst +++ b/llvm/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 <CommandGuide/index>`
- 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 <ReleaseNotes>`
This describes new features, known bugs, and other limitations.
-:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
- A reference manual for using the LLVM testing infrastructure.
-
:doc:`TestSuiteGuide`
Describes how to compile and run the test-suite benchmarks.
diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index 40cadd4af84..944ca8bdfdb 100644 --- a/llvm/docs/index.rst +++ b/llvm/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 ========= |
