lance-format / lance-format/lance
Document pyo3 generated types with mkdocs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7.1k
- Forks
- 852
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 272
Description
I believe pyo3 will generate docstrings on the generated python code. So it should be possible to include these types in the mkdocs. However, these types do not show up in mkdocs. Perhaps we just need to add them to the index?
A good example is the CleanupStats returned from cleanup_old_versions: https://lance-format.github.io/lance-python-doc/all-modules.html#lance.LanceDataset.cleanup_old_versions
Contributor guide
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 inspecting the generated Python API documentation around CleanupStats and the all-modules page linked in the issue, then trace how these pyo3-generated types are discovered by mkdocs. Done means CleanupStats and similar generated types appear in the published API documentation with the expected links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100