Skip to content

patrick91/rusty-docs

Repository files navigation

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

  • WASM library
  • Python library
  • Generate markdown files
  • Extract docs from classes
  • Extract docs from methods
  • Extract docs from functions
  • Extract docs from modules

Installation

TBC

Usage

TBC

Test

cargo test

Review snapshots

cargo install cargo-insta
cargo insta review

About

rusty-docs

Resources

License

Stars

Watchers

Forks

Packages

No packages published