serde-doc 0.1.0

A tool to generate documentation for Serde serialization and deserialization.
Documentation
  • Coverage
  • 0%
    0 out of 35 items documented0 out of 17 items with examples
  • Size
  • Source code size: 21.27 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.88 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 29s Average build duration of successful builds.
  • all releases: 29s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • charlesxsh

Crates.io

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 .