A Rust crate to generate documentation for JavaScript and TypeScript modules.
This crate powers
deno doc
, but is not
Deno specific and can be used to write documentation generators for other
targets like Node or the browser as well.
examples/ddoc/main.rs
provides a minimal standalone binary demonstrating how deno_doc
can be used as a crate.
$ cargo run --example ddoc ../deno/std/http/mod.ts
make sure that folder structure as follow, or you will get error
.
├── deno
├── deno_doc
Make sure to have latest stable version of Rust installed (1.45.0).
// check version
$ rustc --version
rustc 1.45.0 (5c1f21c3b 2020-07-13)
// build all targets
$ cargo build --all-targets
// test it
$ cargo test
-
If you are going to work on an issue, mention so in the issue comments before you start working on the issue.
-
Please be professional in the forums. We follow Rust's code of conduct (CoC) Have a problem? Email ry@tinyclouds.org.
-
Ask for help in the community chat room.
Before submitting, please make sure the following is done:
- That there is a related issue and it is referenced in the PR text.
- There are tests that cover the changes.
- Ensure
cargo test
passes. - Format your code with
rustfmt --check src/lib.rs
- Make sure
cargo clippy --all-targets --release --locked -- -D clippy::all
passes.