rusty-docs
v0.1.21
Published
Rusty docs
Downloads
31
Readme
Rusty docs
A simple documentation generator for Python code. This is meant to be a tool that generates markdown files from docstrings in your code. It is been designed to be used by Strawberry GraphQL's source code, so it might not be the best tool for your use case. However, if you are interested in using it, feel free to open an issue or a PR!
Roadmap
- [ ] Node.js library
- [ ] Python library
- [x] Generate markdown files
- [ ] Extract docs from classes
- [ ] Extract docs from methods
- [x] Extract docs from functions
- [ ] Extract docs from modules
Installation
TBC
Usage
TBC
Test
cargo test`
Review snapshots
cargo insta review