#derive #run #macro #opt2doc

macro opt2doc_derive

Derive macro for opt2doc

3 releases

0.1.2 Apr 17, 2024
0.1.1 Apr 17, 2024
0.1.0 Apr 15, 2024

#1236 in Procedural macros

48 downloads per month

MIT license

25KB
497 lines

This reposity contains two packages:

  • opt2doc is a binary that can be run as cargo subcommand
  • opt2doc_derive is a library that can be used to derive opt2doc for your own types

Command Args

Key Type Default Descriptions Deprecated
name Option -- Optional name to operate on
repo PathBuf . Repo dir to search for the cargo workspace.
output PathBuf target/opt2doc/ The path output files.
render RenderFormat -- Format to render.
root Option -- Name of the root option struct. Setting this will ignore all other options
that are not accessible from the given root.
config Option -- The path of config file. E.g., ./opt2doc.toml.

Road Map

  • support enum derive
  • support add #[opt2doc(skip)] to skip some fields
  • support add link to type using rustdoc's json output(Maybe using trustfall_rustdoc)

Dependencies

~3–10MB
~112K SLoC