docfx

command

v0.0.0-...-b43a714 Latest Latest Go to latest Published: Apr 8, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Details

This tool generates DocFX YAML for Rust crates.

This tool requires cargo nightly build to generate rustdoc json file and docuploader to upload the generated docfx yaml tar file.

Example usage for all crates:

rustdocfx -project-root ./../../

Example usage for a single crate:

rustdocfx -project-root ./../../ google-cloud-secretmanager-v1

go test ./doc/rustdocfx/... ./tools/golints/...

Rustdocfx generates for Google Rust SDK reference documentation in DocFx YAML format. See https://github.com/googleapis/doc-pipeline for more information.

Usage:

rustdocfx [flags] [crate ...]

The flags are:

    -out
	Write the result custom/file/path instead of stdout.
    -project-root
	Top level directory of googleapis/google-cloud-rust.