mirror of https://github.com/rust-lang/cargo
65 lines
2.1 KiB
Rust
65 lines
2.1 KiB
Rust
use crate::command_prelude::*;
|
|
|
|
use cargo::ops::{self, DocOptions};
|
|
|
|
pub fn cli() -> Command {
|
|
subcommand("doc")
|
|
// subcommand aliases are handled in aliased_command()
|
|
// .alias("d")
|
|
.about("Build a package's documentation")
|
|
.arg(flag(
|
|
"open",
|
|
"Opens the docs in a browser after the operation",
|
|
))
|
|
.arg(flag(
|
|
"no-deps",
|
|
"Don't build documentation for dependencies",
|
|
))
|
|
.arg(flag("document-private-items", "Document private items"))
|
|
.arg_message_format()
|
|
.arg_silent_suggestion()
|
|
.arg_package_spec(
|
|
"Package to document",
|
|
"Document all packages in the workspace",
|
|
"Exclude packages from the build",
|
|
)
|
|
.arg_features()
|
|
.arg_targets_lib_bin_example(
|
|
"Document only this package's library",
|
|
"Document only the specified binary",
|
|
"Document all binaries",
|
|
"Document only the specified example",
|
|
"Document all examples",
|
|
)
|
|
.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_unit_graph()
|
|
.arg_timings()
|
|
.arg_manifest_path()
|
|
.arg_ignore_rust_version()
|
|
.after_help(color_print::cstr!(
|
|
"Run `<cyan,bold>cargo help doc</>` for more detailed information.\n"
|
|
))
|
|
}
|
|
|
|
pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
|
|
let ws = args.workspace(gctx)?;
|
|
let mode = CompileMode::Doc {
|
|
deps: !args.flag("no-deps"),
|
|
json: false,
|
|
};
|
|
let mut compile_opts = args.compile_options(gctx, mode, Some(&ws), ProfileChecking::Custom)?;
|
|
compile_opts.rustdoc_document_private_items = args.flag("document-private-items");
|
|
|
|
let doc_opts = DocOptions {
|
|
open_result: args.flag("open"),
|
|
output_format: ops::OutputFormat::Html,
|
|
compile_opts,
|
|
};
|
|
ops::doc(&ws, &doc_opts)?;
|
|
Ok(())
|
|
}
|