LLVM Discussion Forums

Autogenerating python API docs

I’ve been developing the MLIR python bindings and would like to figure out how to publish some auto-generated docs. Is there someone who can help me with the project infra side of it (I can do the work but have never done anything in this area for LLVM).

I’ve found that generating the python docs seems the most reasonable with Sphinx, which is a bit of a pill to get configured right for your project but is then just a matter of running “make” with appropriate python packages involved.

Example: https://github.com/stellaraccident/stellaraccident.github.io/tree/master/mlir-python-preview
Built Site: https://stellaraccident.github.io/mlir-python-preview/_build/html/index.html

The catch is that since this processes the Python native extension, it needs to run against a built directory of MLIR/LLVM.

Any pointers?