Add doxygen docs for runtime_lib

arkhodamoradi · Feb 8, 2023 · 03f625f · 03f625f
1 parent da8f65f
commit 03f625f
Show file tree

Hide file tree

Showing 6 changed files with 2,396 additions and 21 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -87,6 +87,7 @@ set_target_properties(aie-headers PROPERTIES FOLDER "Misc")
 add_dependencies(aie-headers mlir-headers)
 # Make sure we build the docs
 add_custom_target(docs ALL)
+add_subdirectory(docs)
 add_dependencies(docs mlir-doc)
 
 # python install directory

diff --git a/docs/README.md b/docs/README.md
@@ -19,10 +19,11 @@ Generated code documentation
 - [ADF Dialect](ADFDialect.md) - [ADF Passes](ADFPasses.md)
 
 Tutorials
+- [Step-by-step Tutorial](../tutorials/README.md)
 - [AIE Design Patterns](AIEDesignPatterns)
 - [AIE Routing](AIERouting)
 - [AIE Vectorization of Scalar Code](AIEVectorization)
 
 -----
 
-<p align="center">Copyright&copy; 2019-2022 AMD/Xilinx</p>
+<p align="center">Copyright&copy; 2019-2023 AMD/Xilinx</p>
diff --git a/docs/doxygen-mainpage.dox b/docs/doxygen-mainpage.dox
@@ -0,0 +1,10 @@
+/// \mainpage MLIR-AIE
+///
+/// \section main_intro Introduction
+/// Welcome to the MLIR-AIE project.
+///
+/// This documentation describes the **internal** software that makes
+/// up MLIR, not the **external** use of MLIR. There are no instructions
+/// here on how to use MLIR, only the APIs that make up the software. For
+/// usage instructions, please see the [project website](http://mlir.llvm.org)
+/// for further detail.