File tree Expand file tree Collapse file tree 4 files changed +39
-1
lines changed Expand file tree Collapse file tree 4 files changed +39
-1
lines changed Original file line number Diff line number Diff line change @@ -31,6 +31,14 @@ option.
31
31
32
32
{{#option "` --no-deps ` " }}
33
33
Do not build documentation for dependencies.
34
+
35
+ ** Note:** Documentation is _ cumulative_ . If you’ve already run
36
+ ` cargo doc ` (including dependency docs), and later run
37
+ ` cargo doc --no-deps ` , Cargo will skip deleting or rebuilding those
38
+ old dependency docs. To remove them, you can either:
39
+
40
+ 1 . Run ` cargo clean --doc ` before ` cargo doc --no-deps ` , or
41
+ 2 . Manually delete the unwanted folders under ` target/doc/ ` .
34
42
{{/option}}
35
43
36
44
{{#option "` --document-private-items ` " }}
Original file line number Diff line number Diff line change @@ -22,6 +22,15 @@ OPTIONS
22
22
--no-deps
23
23
Do not build documentation for dependencies.
24
24
25
+ Note: Documentation is cumulative. If you’ve already run cargo doc
26
+ (including dependency docs), and later run cargo doc --no-deps,
27
+ Cargo will skip deleting or rebuilding those old dependency docs. To
28
+ remove them, you can either:
29
+
30
+ 1. Run cargo clean --doc before cargo doc --no-deps, or
31
+
32
+ 2. Manually delete the unwanted folders under target/doc/.
33
+
25
34
--document-private-items
26
35
Include non-public items in the documentation. This will be enabled
27
36
by default if documenting a binary target.
Original file line number Diff line number Diff line change @@ -26,7 +26,15 @@ option.</dd>
26
26
27
27
28
28
<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 >
29
- <dd class =" option-desc " >Do not build documentation for dependencies.</dd >
29
+ <dd class =" option-desc " >Do not build documentation for dependencies.</p >
30
+ <p ><strong >Note:</strong > Documentation is <em >cumulative</em >. If you’ve already run
31
+ <code >cargo doc</code > (including dependency docs), and later run
32
+ <code >cargo doc --no-deps</code >, Cargo will skip deleting or rebuilding those
33
+ old dependency docs. To remove them, you can either:</p >
34
+ <ol >
35
+ <li >Run <code >cargo clean --doc</code > before <code >cargo doc --no-deps</code >, or</li >
36
+ <li >Manually delete the unwanted folders under <code >target/doc/</code >.</li >
37
+ </ol ></dd >
30
38
31
39
32
40
<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 >
Original file line number Diff line number Diff line change @@ -24,6 +24,19 @@ option.
24
24
\fB \-\- no \- deps \fR
25
25
.RS 4
26
26
Do not build documentation for dependencies.
27
+ .sp
28
+ \fB Note: \fR Documentation is \fI cumulative \fR \& . If you\[cq ] ve already run
29
+ \fB cargo doc \fR (including dependency docs), and later run
30
+ \fB cargo doc \-\- no \- deps \fR , Cargo will skip deleting or rebuilding those
31
+ old dependency docs. To remove them, you can either:
32
+ .sp
33
+ .RS 4
34
+ \h '-04' 1.\h '+01' Run \fB cargo clean \-\- doc \fR before \fB cargo doc \-\- no \- deps \fR , or
35
+ .RE
36
+ .sp
37
+ .RS 4
38
+ \h '-04' 2.\h '+01' Manually delete the unwanted folders under \fB target/doc/ \fR \& .
39
+ .RE
27
40
.RE
28
41
.sp
29
42
\fB \-\- document \- private \- items \fR
You can’t perform that action at this time.
0 commit comments