llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104,593 建立於 2024年8月16日

在 GitHub 查看
 (9 留言) (0 反應) (1 負責人)C++ (10,782 fork)batch import
good first issuemlir:core

倉庫指標

Star
 (26,378 star)
PR 合併指標
 (平均合併 1天 2小時) (30 天內合併 1,000 個 PR)

描述

MLIR tblgen support auto generating attr/type/op/enum docs, and a dialect doc that contains them all. This is done in OpDocGen.cpp. However, it doesn't support generating docs for op interfaces (generated via -gen-op-interface-*).

It would be great to add support for that, such that the generated doc will show the following info for each op-interafce - summary, description, base interfaces, and methods.

貢獻者指南

研究方向
研究 OpDocGen.cpp 中現有的自動文檔生成程式碼，了解 attr/type/op/enum 文檔是如何生成的，然後透過添加對 ' gen op interface *' 後端的支援，將其擴展到處理操作介面。
技術棧
cpp
領域
backenddocumentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
C++MLIR
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50