search

llvm / llvm-project

The LLVM Project is a collection of modular and reusable compiler and toolchain technologies.
http://llvm.org
Other
28.02k stars 11.57k forks source link

[mlir] Auto generate docs for dialect op interfaces #104593

Open tomnatan30 opened 1 month ago

tomnatan30 commented 1 month ago

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.

llvmbot commented 1 month ago

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

  1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
  2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
  3. Fix the issue locally.
  4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
  5. Create a Git commit.
  6. Run git clang-format HEAD~1 to format your changes.
  7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

llvmbot commented 1 month ago

@llvm/issue-subscribers-good-first-issue

Author: Tom Natan (tomnatan30)

MLIR tblgen support auto generating attr/type/op/enum docs, and a dialect doc that contains them all. This is done in [OpDocGen.cpp](https://github.com/llvm/llvm-project/blob/main/mlir/tools/mlir-tblgen/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.
llvmbot commented 1 month ago

@llvm/issue-subscribers-mlir-core

Author: Tom Natan (tomnatan30)

MLIR tblgen support auto generating attr/type/op/enum docs, and a dialect doc that contains them all. This is done in [OpDocGen.cpp](https://github.com/llvm/llvm-project/blob/main/mlir/tools/mlir-tblgen/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.
ammar2199 commented 1 month ago

@tomnatan30 Hi! I'm a first-time contributor. I'd love to give it a shot! Could you please assign the task to me?

tomnatan30 commented 1 month ago

Awesome! Happy to help, let me know if you have any questions.