Add sphinx docs for python bindings and scripts for CI #235
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The CI passed with generated sphinx docs. Although we cannot preview the webpage before merging. |
|
I uploaded the sphinx-generated site to surge.sh so everyone can preview it now: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It closes #97.
This PR adds sphinx to generate API documentation for python bindings. It is achieved via the sphinx-autoapi since there are several issues while the vanilla sphinx is used for MLIR python (mostly due to namespace package and importing).
If the workflow runs without errors (that's what I expect, although in most cases we need some interactive rounds to debug the workflow) and after this PR is merged, the API docs should be available in https://mlir.llvm.org/python-bindings/.
cc @jpienaar @joker-eph @makslevental