serde-doc
| Crates.io | serde-doc |
| lib.rs | serde-doc |
| version | 0.1.0 |
| created_at | 2025-03-28 21:31:29.098799+00 |
| updated_at | 2025-03-28 21:31:29.098799+00 |
| description | A tool to generate documentation for Serde serialization and deserialization. |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1610485 |
| size | 21,757 |
Shihao Xia (charlesxsh)
documentation
README
serde-doc is an tool that generates documentations for the serde structures in your source code without modifying any source code.
Features
-
Markdown (WIP) Direct human readable markdown document for the serde structures
-
JSON Schema (WIP) JSON Schema gives you more flexibilities to use other document generators.
Usage
A cargo extension CLI for generating documentation for serde structs
Usage: cargo serde-doc [OPTIONS] <COMMAND> [ARGS]
Commands:
list List available serde structs
gen Generate files using a generator
help Print this message or the help of the given subcommand(s)
Options:
-m, --manifest-path <MANIFEST_PATH> Path to the Cargo.toml file or directory containing it [default: .]
-h, --help Print help
-V, --version Print version
Dev
cargo install --path .