mirror of https://github.com/rust-lang/cargo
89 lines
2.7 KiB
Rust
89 lines
2.7 KiB
Rust
use cargo::ops::{self, DocOptions, OutputFormat};
|
|
|
|
use crate::command_prelude::*;
|
|
|
|
pub fn cli() -> Command {
|
|
subcommand("rustdoc")
|
|
.about("Build a package's documentation, using specified custom flags.")
|
|
.arg(
|
|
Arg::new("args")
|
|
.value_name("ARGS")
|
|
.help("Extra rustdoc flags")
|
|
.num_args(0..)
|
|
.trailing_var_arg(true),
|
|
)
|
|
.arg(flag(
|
|
"open",
|
|
"Opens the docs in a browser after the operation",
|
|
))
|
|
.arg_message_format()
|
|
.arg_silent_suggestion()
|
|
.arg_package("Package to document")
|
|
.arg_targets_all(
|
|
"Build only this package's library",
|
|
"Build only the specified binary",
|
|
"Build all binaries",
|
|
"Build only the specified example",
|
|
"Build all examples",
|
|
"Build only the specified test target",
|
|
"Build all test targets",
|
|
"Build only the specified bench target",
|
|
"Build all bench targets",
|
|
"Build all targets",
|
|
)
|
|
.arg_features()
|
|
.arg_parallel()
|
|
.arg_release("Build artifacts in release mode, with optimizations")
|
|
.arg_profile("Build artifacts with the specified profile")
|
|
.arg_target_triple("Build for the target triple")
|
|
.arg_target_dir()
|
|
.arg(
|
|
opt("output-format", "The output type to write (unstable)")
|
|
.value_name("FMT")
|
|
.value_parser(OutputFormat::POSSIBLE_VALUES),
|
|
)
|
|
.arg_unit_graph()
|
|
.arg_timings()
|
|
.arg_manifest_path()
|
|
.arg_ignore_rust_version()
|
|
.after_help(color_print::cstr!(
|
|
"Run `<cyan,bold>cargo help rustdoc</>` for more detailed information.\n"
|
|
))
|
|
}
|
|
|
|
pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
|
|
let ws = args.workspace(gctx)?;
|
|
let output_format = if let Some(output_format) = args._value_of("output-format") {
|
|
gctx.cli_unstable()
|
|
.fail_if_stable_opt("--output-format", 12103)?;
|
|
output_format.parse()?
|
|
} else {
|
|
OutputFormat::Html
|
|
};
|
|
|
|
let mut compile_opts = args.compile_options_for_single_package(
|
|
gctx,
|
|
CompileMode::Doc {
|
|
deps: false,
|
|
json: matches!(output_format, OutputFormat::Json),
|
|
},
|
|
Some(&ws),
|
|
ProfileChecking::Custom,
|
|
)?;
|
|
let target_args = values(args, "args");
|
|
|
|
compile_opts.target_rustdoc_args = if target_args.is_empty() {
|
|
None
|
|
} else {
|
|
Some(target_args)
|
|
};
|
|
|
|
let doc_opts = DocOptions {
|
|
open_result: args.flag("open"),
|
|
output_format,
|
|
compile_opts,
|
|
};
|
|
ops::doc(&ws, &doc_opts)?;
|
|
Ok(())
|
|
}
|