diff --git a/docs/GettingInvolved.rst b/docs/GettingInvolved.rst index 3da4d31ac43..343b226231a 100644 --- a/docs/GettingInvolved.rst +++ b/docs/GettingInvolved.rst @@ -3,6 +3,9 @@ Getting Involved LLVM welcomes contributions of all kinds. To get started, please review the following topics: +.. contents:: + :local: + .. toctree:: :hidden: diff --git a/docs/Reference.rst b/docs/Reference.rst new file mode 100644 index 00000000000..2178eb1bc40 --- /dev/null +++ b/docs/Reference.rst @@ -0,0 +1,39 @@ +Reference +========= + +LLVM and API reference documentation. + +.. toctree:: + :hidden: + + LangRef + CommandGuide/index + TestingGuide + CompilerWriterInfo + MIRLangRef + +: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. + +:doc:`CompilerWriterInfo` + A list of helpful links for compiler writers. + +:doc:`Machine IR (MIR) Format Reference Manual ` + A reference manual for the MIR serialization format, which is used to test + LLVM's code generation passes. + +`Doxygen generated documentation `_ + (`classes `_) + +`Documentation for Go bindings `_ + +`Github Source Repository Browser `_ + .. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index f029aa70801..4e9bee3c337 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,6 +58,7 @@ Getting Started, How-tos, Developer Guides, and Tutorials. UserGuides ProgrammingDocumentation + Reference SubsystemDocumentation :doc:`UserGuides` @@ -69,6 +70,9 @@ Getting Started, How-tos, Developer Guides, and Tutorials. :doc:`SubsystemDocumentation` For API clients and LLVM developers. +:doc:`Reference` + LLVM and API reference documentation. + Getting Started/Tutorials ------------------------- @@ -92,46 +96,6 @@ Getting Started/Tutorials An addendum to the main Getting Started guide for those using Visual Studio on Windows. -Reference ---------- - -LLVM and API reference documentation. - -.. toctree:: - :hidden: - - LangRef - CommandGuide/index - TestingGuide - CompilerWriterInfo - MIRLangRef - -: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. - -:doc:`CompilerWriterInfo` - A list of helpful links for compiler writers. - -:doc:`Machine IR (MIR) Format Reference Manual ` - A reference manual for the MIR serialization format, which is used to test - LLVM's code generation passes. - -`Doxygen generated documentation `_ - (`classes `_) - -`Documentation for Go bindings `_ - -`Github Source Repository Browser `_ - .. - Community =========