https://github.com/patrick91/rusty-docs
rusty-docs
https://github.com/patrick91/rusty-docs
Last synced: 4 months ago
JSON representation
rusty-docs
- Host: GitHub
- URL: https://github.com/patrick91/rusty-docs
- Owner: patrick91
- License: mit
- Created: 2022-10-12T21:45:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-24T22:25:56.000Z (over 3 years ago)
- Last Synced: 2025-10-18T21:56:10.103Z (8 months ago)
- Language: Rust
- Size: 120 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](https://strawberry.rocks)'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
- [ ] WASM 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
```bash
cargo test
```
### Review snapshots
```bash
cargo install cargo-insta
cargo insta review
```