We need a documentation page that hosts docs generated automatically by MLIR tablegen, which should at least cover the attributes, types, passes, and operations defined in ReuseIR. The documentation page may additionally contain extra pages rendered from markdown files in the source tree (for example, the documentation of the ReuseIR frontend and runtime should also be included).
ClangIR: https://clangir.org (Note that ClangIR doc does not keep consistency in visual styles with other typical MLIR dialect docs, we'd better avoid this)
Most MLIR dialect docs, including the MLIR official docs, use Hugo together with this Hugo template.
Some immediate works required:
[x] Scaffold the Hugo site under a new directory reuse-doc, setup necessary github workflows to deploy this site to github pages.
[x] Add a new CMake target under reuse-mlir that generates markdown files from documentations embedded in the tablegen files, and incorporate these generated markdown files to the hugo site.
Lancern
commented
2 months ago
We need a documentation page that hosts docs generated automatically by MLIR tablegen, which should at least cover the attributes, types, passes, and operations defined in ReuseIR. The documentation page may additionally contain extra pages rendered from markdown files in the source tree (for example, the documentation of the ReuseIR frontend and runtime should also be included).
Some examples from other MLIR dialects:
Most MLIR dialect docs, including the MLIR official docs, use Hugo together with this Hugo template.
Some immediate works required:
reuse-doc, setup necessary github workflows to deploy this site to github pages.reuse-mlirthat generates markdown files from documentations embedded in the tablegen files, and incorporate these generated markdown files to the hugo site.