tests Document all targets in test mode that have the test = true manifestįlag set. Multiple times and supports common Unix glob patterns.

test name… Document the specified integration test. This flag may be specified multiple timesĪnd supports common Unix glob patterns. example name… Document the specified example. bin name… Document the specified binary. Use single quotes or double quotes around each glob pattern. Shell accidentally expanding glob patterns before Cargo handles them, you must Support common Unix glob patterns like *, ? and. Note that -bin, -example, -test and -bench flags also Passing target selection flags will document only the specified If its name is the same as the lib target. When no target selection options are given, cargo rustdoc will document allīinary and library targets of the selected package. p spec -package spec The package to document. The -pįlag can be used to choose a different package in a workspace. This will use your defaultīrowser unless you define another one in the BROWSER environment variableīy default, the package in the current working directory is selected. OPTIONS Documentation Options -open Open the docs in a browser after building them. To pass flags to all rustdoc processes spawned by Cargo, use the Package the filters of -lib, -bin, etc, must be used to select which If more than one target is available for the current This command requires that only one target is being compiled when additionalĪrguments are provided.

Note that rustdoc will still unconditionally receive arguments suchĪs -L, -extern, and -crate-type, and the specified args will simply Dependencies will not be documented as part of thisĬommand. Provided) will be documented with the specified args being passed to theįinal rustdoc invocation. The specified target for the current package (or package specified by -p if Cargo-rustdoc - Build a package’s documentation, using specified custom flags SYNOPSISĬargo rustdoc DESCRIPTION

Rust cargo book