scylladb / scylladb/python-rs-driver
docs: Automate API reference generation from compiled backend stubs (.pyi)
Open
@pasinskik is already working on this.
Since May 22, 2026.
area/documentation
- Dominant language
- Rust
- Stars
- 6
- Forks
- 7
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 9
Description
Objective
Fully document the driver's public Python API reference without maintaining redundant strings. Because our heavy execution logic and core classes live in a compiled Rust extension (scylla._rust), Python ignores their attached .pyi stub files at runtime, leaving standard Sphinx autodoc directives blank. We need to build an automated bridge to pull these descriptions and type hints dynamically.
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.
Assessment
This issue has not been assessed yet.