cargo-insert-docs 1.6.0

Inserts feature docs into crate docs, and crate docs into README.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

### CLI Arguments

```console
$ cargo insert-docs -h

Inserts crate docs into a readme file and feature docs into the crate docs.

Usage: cargo insert-docs [OPTIONS] [COMMAND]

Commands:
  feature-into-crate  Only inserts feature documentation into crate documentation
  crate-into-readme   Only inserts crate documentation into the readme file
  help                Print this message or the help of the given subcommand(s)

Options:
      --feature-label <FEATURE_LABEL>  Formatting of the feature label [default: "**`{feature}`**"]
      --feature-section-name <NAME>    Feature documentation section name [default: "feature documentation"]
      --crate-section-name <NAME>      Crate documentation section name [default: "crate documentation"]
      --shrink-headings <AMOUNT>       Shrink headings by this amount [default: 1]
      --link-to-latest                 Link to the "latest" version on docs.rs
      --print-supported-toolchain      Prints a supported nightly toolchain
      --print-config                   Prints configuration values and their sources for debugging
  -h, --help                           Print help (see more with '--help')
  -V, --version                        Print version

Cargo Doc Options:
      --document-private-items  Document private items
      --no-deps                 Don't build documentation for dependencies

Mode Selection:
      --check  Runs in 'check' mode, not writing to files but erroring if something is out of date

Error Behavior:
      --allow-missing-section  Don't error when a section is missing
      --allow-dirty            Insert documentation even if the affected file is dirty or has staged changes
      --allow-staged           Insert documentation even if the affected file has staged changes

Message Options:
      --color <WHEN>  Coloring [default: "auto"] [possible values: auto, always, never]
  -v, --verbose...    Print more verbose messages
  -q, --quiet         Do not print anything
      --quiet-cargo   Do not print cargo log messages

Package Selection:
  -p, --package <SPEC>  Package(s) to document
      --workspace       Document all packages in the workspace
      --exclude <SPEC>  Exclude package(s) from documenting

Feature Selection:
  -F, --features <FEATURES>         Space or comma separated list of features to activate
      --all-features                Activate all available features
      --no-default-features         Do not activate the `default` feature
      --hidden-features <FEATURES>  Space or comma separated list of features to hide from the documentation

Target Selection:
      --lib           Document only library targets
      --bin [<NAME>]  Document only the specified binary

Compilation Options:
      --toolchain <TOOLCHAIN>   Which rustup toolchain to use when invoking rustdoc [default: "nightly-2026-04-14"]
      --target <TRIPLE>         Target triple to document
      --target-dir <DIRECTORY>  Directory for all generated artifacts

Manifest Options:
      --manifest-path <PATH>  Path to Cargo.toml
      --readme-path <PATH>    Readme path relative to the package manifest
```