Any way to generate the dialect documenation with all the definitions of the MLIR operations?

MLIR
1

Hi guys,

I am applying MLIR in my project, and defined several dialects with ODS operations.

I wonder is there any tools to generate documentation like memref operation definitions automatically based on the ODS .td files.

Thank you!

2

Yes, look at the add_mlir_doc CMake macro and its invocation of mlir-tblgen that it expands to (add_mlir_doc(MemRefOps MemRefOps Dialects/ -gen-dialect-doc))

3

Oh and for going from Markdown to website, see https://github.com/llvm/mlir-www/blob/main/.github/workflows/main.yml and other scripts invoked there.