]>
Commit | Line | Data |
---|---|---|
2d4aa38b EH |
1 | # cargo-doc(1) |
2 | ||
3 | ||
4 | ## NAME | |
5 | ||
6 | cargo-doc - Build a package's documentation | |
7 | ||
8 | ## SYNOPSIS | |
9 | ||
10 | `cargo doc` [_options_] | |
11 | ||
12 | ## DESCRIPTION | |
13 | ||
14 | Build the documentation for the local package and all dependencies. The output | |
15 | is placed in `target/doc` in rustdoc's usual format. | |
16 | ||
17 | ## OPTIONS | |
18 | ||
19 | ### Documentation Options | |
20 | ||
21 | <dl> | |
22 | ||
23 | <dt class="option-term" id="option-cargo-doc---open"><a class="option-anchor" href="#option-cargo-doc---open"></a><code>--open</code></dt> | |
24 | <dd class="option-desc">Open the docs in a browser after building them. This will use your default | |
6128b54b J |
25 | browser unless you define another one in the <code>BROWSER</code> environment variable |
26 | or use the <a href="../reference/config.html#docbrowser"><code>doc.browser</code></a> configuration | |
27 | option.</dd> | |
2d4aa38b EH |
28 | |
29 | ||
30 | <dt class="option-term" id="option-cargo-doc---no-deps"><a class="option-anchor" href="#option-cargo-doc---no-deps"></a><code>--no-deps</code></dt> | |
31 | <dd class="option-desc">Do not build documentation for dependencies.</dd> | |
32 | ||
33 | ||
34 | <dt class="option-term" id="option-cargo-doc---document-private-items"><a class="option-anchor" href="#option-cargo-doc---document-private-items"></a><code>--document-private-items</code></dt> | |
61282336 | 35 | <dd class="option-desc">Include non-public items in the documentation. This will be enabled by default if documenting a binary target.</dd> |
2d4aa38b EH |
36 | |
37 | ||
38 | </dl> | |
39 | ||
40 | ### Package Selection | |
41 | ||
42 | By default, when no package selection options are given, the packages selected | |
43 | depend on the selected manifest file (based on the current working directory if | |
44 | `--manifest-path` is not given). If the manifest is the root of a workspace then | |
45 | the workspaces default members are selected, otherwise only the package defined | |
46 | by the manifest will be selected. | |
47 | ||
48 | The default members of a workspace can be set explicitly with the | |
49 | `workspace.default-members` key in the root manifest. If this is not set, a | |
50 | virtual workspace will include all workspace members (equivalent to passing | |
51 | `--workspace`), and a non-virtual workspace will include only the root crate itself. | |
52 | ||
53 | <dl> | |
54 | ||
55 | <dt class="option-term" id="option-cargo-doc--p"><a class="option-anchor" href="#option-cargo-doc--p"></a><code>-p</code> <em>spec</em>...</dt> | |
56 | <dt class="option-term" id="option-cargo-doc---package"><a class="option-anchor" href="#option-cargo-doc---package"></a><code>--package</code> <em>spec</em>...</dt> | |
1a86f232 | 57 | <dd class="option-desc">Document only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the |
4a61d8a4 WL |
58 | SPEC format. This flag may be specified multiple times and supports common Unix |
59 | glob patterns like <code>*</code>, <code>?</code> and <code>[]</code>. However, to avoid your shell accidentally | |
60 | expanding glob patterns before Cargo handles them, you must use single quotes or | |
61 | double quotes around each pattern.</dd> | |
2d4aa38b EH |
62 | |
63 | ||
64 | <dt class="option-term" id="option-cargo-doc---workspace"><a class="option-anchor" href="#option-cargo-doc---workspace"></a><code>--workspace</code></dt> | |
65 | <dd class="option-desc">Document all members in the workspace.</dd> | |
66 | ||
67 | ||
68 | ||
69 | <dt class="option-term" id="option-cargo-doc---all"><a class="option-anchor" href="#option-cargo-doc---all"></a><code>--all</code></dt> | |
70 | <dd class="option-desc">Deprecated alias for <code>--workspace</code>.</dd> | |
71 | ||
72 | ||
73 | ||
74 | <dt class="option-term" id="option-cargo-doc---exclude"><a class="option-anchor" href="#option-cargo-doc---exclude"></a><code>--exclude</code> <em>SPEC</em>...</dt> | |
75 | <dd class="option-desc">Exclude the specified packages. Must be used in conjunction with the | |
4a61d8a4 WL |
76 | <code>--workspace</code> flag. This flag may be specified multiple times and supports |
77 | common Unix glob patterns like <code>*</code>, <code>?</code> and <code>[]</code>. However, to avoid your shell | |
78 | accidentally expanding glob patterns before Cargo handles them, you must use | |
79 | single quotes or double quotes around each pattern.</dd> | |
2d4aa38b EH |
80 | |
81 | ||
82 | </dl> | |
83 | ||
84 | ||
85 | ### Target Selection | |
86 | ||
87 | When no target selection options are given, `cargo doc` will document all | |
88 | binary and library targets of the selected package. The binary will be skipped | |
89 | if its name is the same as the lib target. Binaries are skipped if they have | |
90 | `required-features` that are missing. | |
91 | ||
92 | The default behavior can be changed by setting `doc = false` for the target in | |
93 | the manifest settings. Using target selection options will ignore the `doc` | |
94 | flag and will always document the given target. | |
95 | ||
96 | <dl> | |
97 | <dt class="option-term" id="option-cargo-doc---lib"><a class="option-anchor" href="#option-cargo-doc---lib"></a><code>--lib</code></dt> | |
98 | <dd class="option-desc">Document the package's library.</dd> | |
99 | ||
100 | ||
101 | <dt class="option-term" id="option-cargo-doc---bin"><a class="option-anchor" href="#option-cargo-doc---bin"></a><code>--bin</code> <em>name</em>...</dt> | |
4a61d8a4 WL |
102 | <dd class="option-desc">Document the specified binary. This flag may be specified multiple times |
103 | and supports common Unix glob patterns.</dd> | |
2d4aa38b EH |
104 | |
105 | ||
106 | <dt class="option-term" id="option-cargo-doc---bins"><a class="option-anchor" href="#option-cargo-doc---bins"></a><code>--bins</code></dt> | |
107 | <dd class="option-desc">Document all binary targets.</dd> | |
108 | ||
109 | ||
110 | </dl> | |
111 | ||
112 | ### Feature Selection | |
113 | ||
d087aeb8 EH |
114 | The feature flags allow you to control which features are enabled. When no |
115 | feature options are given, the `default` feature is activated for every | |
116 | selected package. | |
2d4aa38b | 117 | |
d087aeb8 EH |
118 | See [the features documentation](../reference/features.html#command-line-feature-options) |
119 | for more details. | |
2d4aa38b EH |
120 | |
121 | <dl> | |
122 | ||
123 | <dt class="option-term" id="option-cargo-doc---features"><a class="option-anchor" href="#option-cargo-doc---features"></a><code>--features</code> <em>features</em></dt> | |
d087aeb8 EH |
124 | <dd class="option-desc">Space or comma separated list of features to activate. Features of workspace |
125 | members may be enabled with <code>package-name/feature-name</code> syntax. This flag may | |
126 | be specified multiple times, which enables all specified features.</dd> | |
2d4aa38b EH |
127 | |
128 | ||
129 | <dt class="option-term" id="option-cargo-doc---all-features"><a class="option-anchor" href="#option-cargo-doc---all-features"></a><code>--all-features</code></dt> | |
130 | <dd class="option-desc">Activate all available features of all selected packages.</dd> | |
131 | ||
132 | ||
133 | <dt class="option-term" id="option-cargo-doc---no-default-features"><a class="option-anchor" href="#option-cargo-doc---no-default-features"></a><code>--no-default-features</code></dt> | |
d087aeb8 | 134 | <dd class="option-desc">Do not activate the <code>default</code> feature of the selected packages.</dd> |
2d4aa38b EH |
135 | |
136 | ||
137 | </dl> | |
138 | ||
139 | ||
140 | ### Compilation Options | |
141 | ||
142 | <dl> | |
143 | ||
144 | <dt class="option-term" id="option-cargo-doc---target"><a class="option-anchor" href="#option-cargo-doc---target"></a><code>--target</code> <em>triple</em></dt> | |
145 | <dd class="option-desc">Document for the given architecture. The default is the host | |
146 | architecture. The general format of the triple is | |
147 | <code><arch><sub>-<vendor>-<sys>-<abi></code>. Run <code>rustc --print target-list</code> for a | |
148 | list of supported targets.</p> | |
149 | <p>This may also be specified with the <code>build.target</code> | |
1a86f232 | 150 | <a href="../reference/config.html">config value</a>.</p> |
2d4aa38b EH |
151 | <p>Note that specifying this flag makes Cargo run in a different mode where the |
152 | target artifacts are placed in a separate directory. See the | |
1a86f232 | 153 | <a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd> |
2d4aa38b EH |
154 | |
155 | ||
156 | ||
157 | <dt class="option-term" id="option-cargo-doc---release"><a class="option-anchor" href="#option-cargo-doc---release"></a><code>--release</code></dt> | |
158 | <dd class="option-desc">Document optimized artifacts with the <code>release</code> profile. See the | |
159 | <a href="#profiles">PROFILES</a> section for details on how this affects profile | |
160 | selection.</dd> | |
161 | ||
162 | ||
163 | ||
164 | </dl> | |
165 | ||
166 | ### Output Options | |
167 | ||
168 | <dl> | |
169 | <dt class="option-term" id="option-cargo-doc---target-dir"><a class="option-anchor" href="#option-cargo-doc---target-dir"></a><code>--target-dir</code> <em>directory</em></dt> | |
170 | <dd class="option-desc">Directory for all generated artifacts and intermediate files. May also be | |
171 | specified with the <code>CARGO_TARGET_DIR</code> environment variable, or the | |
ee53210f WL |
172 | <code>build.target-dir</code> <a href="../reference/config.html">config value</a>. |
173 | Defaults to <code>target</code> in the root of the workspace.</dd> | |
2d4aa38b EH |
174 | |
175 | ||
176 | </dl> | |
177 | ||
178 | ### Display Options | |
179 | ||
180 | <dl> | |
181 | <dt class="option-term" id="option-cargo-doc--v"><a class="option-anchor" href="#option-cargo-doc--v"></a><code>-v</code></dt> | |
182 | <dt class="option-term" id="option-cargo-doc---verbose"><a class="option-anchor" href="#option-cargo-doc---verbose"></a><code>--verbose</code></dt> | |
183 | <dd class="option-desc">Use verbose output. May be specified twice for "very verbose" output which | |
184 | includes extra output such as dependency warnings and build script output. | |
185 | May also be specified with the <code>term.verbose</code> | |
1a86f232 | 186 | <a href="../reference/config.html">config value</a>.</dd> |
2d4aa38b EH |
187 | |
188 | ||
189 | <dt class="option-term" id="option-cargo-doc--q"><a class="option-anchor" href="#option-cargo-doc--q"></a><code>-q</code></dt> | |
190 | <dt class="option-term" id="option-cargo-doc---quiet"><a class="option-anchor" href="#option-cargo-doc---quiet"></a><code>--quiet</code></dt> | |
191 | <dd class="option-desc">No output printed to stdout.</dd> | |
192 | ||
193 | ||
194 | <dt class="option-term" id="option-cargo-doc---color"><a class="option-anchor" href="#option-cargo-doc---color"></a><code>--color</code> <em>when</em></dt> | |
195 | <dd class="option-desc">Control when colored output is used. Valid values:</p> | |
196 | <ul> | |
197 | <li><code>auto</code> (default): Automatically detect if color support is available on the | |
198 | terminal.</li> | |
199 | <li><code>always</code>: Always display colors.</li> | |
200 | <li><code>never</code>: Never display colors.</li> | |
201 | </ul> | |
202 | <p>May also be specified with the <code>term.color</code> | |
1a86f232 | 203 | <a href="../reference/config.html">config value</a>.</dd> |
2d4aa38b EH |
204 | |
205 | ||
206 | ||
207 | <dt class="option-term" id="option-cargo-doc---message-format"><a class="option-anchor" href="#option-cargo-doc---message-format"></a><code>--message-format</code> <em>fmt</em></dt> | |
208 | <dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times | |
209 | and consists of comma-separated values. Valid values:</p> | |
210 | <ul> | |
d174b773 CR |
211 | <li><code>human</code> (default): Display in a human-readable text format. Conflicts with |
212 | <code>short</code> and <code>json</code>.</li> | |
213 | <li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code> | |
214 | and <code>json</code>.</li> | |
2d4aa38b | 215 | <li><code>json</code>: Emit JSON messages to stdout. See |
1a86f232 | 216 | <a href="../reference/external-tools.html#json-messages">the reference</a> |
d174b773 | 217 | for more details. Conflicts with <code>human</code> and <code>short</code>.</li> |
2d4aa38b | 218 | <li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains |
d174b773 | 219 | the "short" rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li> |
2d4aa38b EH |
220 | <li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages |
221 | contains embedded ANSI color codes for respecting rustc's default color | |
d174b773 | 222 | scheme. Cannot be used with <code>human</code> or <code>short</code>.</li> |
2d4aa38b EH |
223 | <li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in |
224 | in JSON messages printed, but instead Cargo itself should render the | |
225 | JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others | |
d174b773 | 226 | coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li> |
2d4aa38b EH |
227 | </ul></dd> |
228 | ||
229 | ||
230 | </dl> | |
231 | ||
232 | ### Manifest Options | |
233 | ||
234 | <dl> | |
235 | <dt class="option-term" id="option-cargo-doc---manifest-path"><a class="option-anchor" href="#option-cargo-doc---manifest-path"></a><code>--manifest-path</code> <em>path</em></dt> | |
236 | <dd class="option-desc">Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the | |
237 | <code>Cargo.toml</code> file in the current directory or any parent directory.</dd> | |
238 | ||
239 | ||
240 | ||
241 | <dt class="option-term" id="option-cargo-doc---frozen"><a class="option-anchor" href="#option-cargo-doc---frozen"></a><code>--frozen</code></dt> | |
242 | <dt class="option-term" id="option-cargo-doc---locked"><a class="option-anchor" href="#option-cargo-doc---locked"></a><code>--locked</code></dt> | |
243 | <dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is | |
244 | up-to-date. If the lock file is missing, or it needs to be updated, Cargo will | |
245 | exit with an error. The <code>--frozen</code> flag also prevents Cargo from | |
246 | attempting to access the network to determine if it is out-of-date.</p> | |
247 | <p>These may be used in environments where you want to assert that the | |
248 | <code>Cargo.lock</code> file is up-to-date (such as a CI build) or want to avoid network | |
249 | access.</dd> | |
250 | ||
251 | ||
252 | <dt class="option-term" id="option-cargo-doc---offline"><a class="option-anchor" href="#option-cargo-doc---offline"></a><code>--offline</code></dt> | |
253 | <dd class="option-desc">Prevents Cargo from accessing the network for any reason. Without this | |
254 | flag, Cargo will stop with an error if it needs to access the network and | |
255 | the network is not available. With this flag, Cargo will attempt to | |
256 | proceed without the network if possible.</p> | |
257 | <p>Beware that this may result in different dependency resolution than online | |
258 | mode. Cargo will restrict itself to crates that are downloaded locally, even | |
259 | if there might be a newer version as indicated in the local copy of the index. | |
1a86f232 | 260 | See the <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going |
2d4aa38b | 261 | offline.</p> |
1a86f232 | 262 | <p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</dd> |
2d4aa38b EH |
263 | |
264 | ||
265 | </dl> | |
266 | ||
267 | ### Common Options | |
268 | ||
269 | <dl> | |
270 | ||
271 | <dt class="option-term" id="option-cargo-doc-+toolchain"><a class="option-anchor" href="#option-cargo-doc-+toolchain"></a><code>+</code><em>toolchain</em></dt> | |
272 | <dd class="option-desc">If Cargo has been installed with rustup, and the first argument to <code>cargo</code> | |
273 | begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such | |
274 | as <code>+stable</code> or <code>+nightly</code>). | |
fac70ee7 | 275 | See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a> |
2d4aa38b EH |
276 | for more information about how toolchain overrides work.</dd> |
277 | ||
278 | ||
279 | <dt class="option-term" id="option-cargo-doc--h"><a class="option-anchor" href="#option-cargo-doc--h"></a><code>-h</code></dt> | |
280 | <dt class="option-term" id="option-cargo-doc---help"><a class="option-anchor" href="#option-cargo-doc---help"></a><code>--help</code></dt> | |
281 | <dd class="option-desc">Prints help information.</dd> | |
282 | ||
283 | ||
284 | <dt class="option-term" id="option-cargo-doc--Z"><a class="option-anchor" href="#option-cargo-doc--Z"></a><code>-Z</code> <em>flag</em></dt> | |
285 | <dd class="option-desc">Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</dd> | |
286 | ||
287 | ||
288 | </dl> | |
289 | ||
290 | ||
291 | ### Miscellaneous Options | |
292 | ||
293 | <dl> | |
294 | <dt class="option-term" id="option-cargo-doc--j"><a class="option-anchor" href="#option-cargo-doc--j"></a><code>-j</code> <em>N</em></dt> | |
295 | <dt class="option-term" id="option-cargo-doc---jobs"><a class="option-anchor" href="#option-cargo-doc---jobs"></a><code>--jobs</code> <em>N</em></dt> | |
296 | <dd class="option-desc">Number of parallel jobs to run. May also be specified with the | |
1a86f232 | 297 | <code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to |
2d4aa38b EH |
298 | the number of CPUs.</dd> |
299 | ||
300 | ||
301 | </dl> | |
302 | ||
303 | ## PROFILES | |
304 | ||
305 | Profiles may be used to configure compiler options such as optimization levels | |
306 | and debug settings. See [the reference](../reference/profiles.html) for more | |
307 | details. | |
308 | ||
309 | Profile selection depends on the target and crate being built. By default the | |
310 | `dev` or `test` profiles are used. If the `--release` flag is given, then the | |
311 | `release` or `bench` profiles are used. | |
312 | ||
313 | Target | Default Profile | `--release` Profile | |
314 | -------|-----------------|--------------------- | |
315 | lib, bin, example | `dev` | `release` | |
316 | test, bench, or any target in "test" or "bench" mode | `test` | `bench` | |
317 | ||
318 | Dependencies use the `dev`/`release` profiles. | |
319 | ||
320 | ||
321 | ## ENVIRONMENT | |
322 | ||
323 | See [the reference](../reference/environment-variables.html) for | |
324 | details on environment variables that Cargo reads. | |
325 | ||
326 | ||
327 | ## EXIT STATUS | |
328 | ||
329 | * `0`: Cargo succeeded. | |
330 | * `101`: Cargo failed to complete. | |
331 | ||
332 | ||
333 | ## EXAMPLES | |
334 | ||
335 | 1. Build the local package documentation and its dependencies and output to | |
336 | `target/doc`. | |
337 | ||
338 | cargo doc | |
339 | ||
340 | ## SEE ALSO | |
1a86f232 | 341 | [cargo(1)](cargo.html), [cargo-rustdoc(1)](cargo-rustdoc.html), [rustdoc(1)](https://doc.rust-lang.org/rustdoc/index.html) |