runtimeverification / runtimeverification/llvm-backend
Generate sphinx documentation for python bindings
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 43
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
It would be helpful to Pi^2's python developers if the python bindings generated for the llvm backend had documentation associated with them. Obviously complete documentation is dependent on annotating the methods with appropriate information, but the bare skeleton of the information ought to be generatable automatically.
We would like to look into how this can be done and then published somewhere online automatically, perhaps at a github.io page.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining how the LLVM backend's generated Python bindings are produced and how Sphinx could consume them. Define an automated path to publish the generated documentation, potentially as a GitHub Pages site; done means a bare documentation skeleton is generated and published online.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100