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