Skip to main content

DOC_HELP

Constant DOC_HELP 

Source
const DOC_HELP: &str = "cargo xtask doc — generate Rust API documentation (rustdoc)

USAGE:
  cargo xtask doc [OPTIONS]

OPTIONS:
      --open                    Open the generated docs in a browser
      --strict                  Treat rustdoc warnings as errors
                                (RUSTDOCFLAGS=\"-D warnings\"; mirrors CI)
      --docsrs-cfg              Append `--cfg docsrs` to RUSTDOCFLAGS so
                                feature-requirement badges render
                                (doc_auto_cfg; requires a nightly toolchain)
      --no-all-features         Document default features only (faster)
      --all-features            Document all features (default)
      --document-private-items  Include private items (internal/team docs)
  -p, --package <NAME>          Document a single workspace package
                                (repeatable; --no-deps is always set)
  -h, --help                    Show this help

DEFAULTS:
  Public items only, no dependency docs, all features. These match the
  repo's documented cargo-doc posture and what `.github/workflows/docs.yml`
  deploys to GitHub Pages. Every run also writes target/doc/index.html (a
  landing page listing all workspace crates) plus openapi.html/openapi.json
  (the REST contract rendered with Redoc).

EXAMPLES:
  cargo xtask doc                     # full workspace API docs
  cargo xtask doc --open              # ...and open in a browser
  cargo xtask doc -p soma-application # one crate only
  cargo xtask doc --strict            # CI-grade (warnings are errors)
  RUSTUP_TOOLCHAIN=nightly cargo xtask doc --docsrs-cfg  # feature badges";