Skip to content

Commit 47e9214

Browse files
QuietMisdreavusjyn514
authored andcommitted
update documentation on package metadata
1 parent 1ae73e9 commit 47e9214

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

templates/about.hbs

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,21 +127,41 @@
127127
</tbody>
128128
</table>
129129

130-
<h4>Metadata for custom builds</h4>
130+
<h4 id="metadata"><a href="#metadata">Metadata for custom builds</a></h4>
131131

132132
<p>You can customize docs.rs builds by defining <code>[package.metadata.docs.rs]</code> table in your crates' `Cargo.toml`.</p>
133133

134-
<p>An example metadata:</p>
134+
<p>The available configuration flags you can customize are:</p>
135135

136136
<pre><code>[package]
137137
name = "test"
138138

139139
[package.metadata.docs.rs]
140+
141+
# Features to pass to Cargo (default: none)
140142
features = [ "feature1", "feature2" ]
143+
144+
# Whether to pass `--all-features` to Cargo (default: false)
141145
all-features = true
146+
147+
# Whether to pass `--no-default-features` to Cargo (default: false)
142148
no-default-features = true
149+
150+
# Target to test build on, used as the default landing page (default: "x86_64-unknown-linux-gnu")
151+
#
152+
# Available targets:
153+
# - x86_64-unknown-linux-gnu
154+
# - x86_64-apple-darwin
155+
# - x86_64-pc-windows-msvc
156+
# - i686-unknown-linux-gnu
157+
# - i686-apple-darwin
158+
# - i686-pc-windows-msvc
143159
default-target = "x86_64-unknown-linux-gnu"
160+
161+
# Additional `RUSTFLAGS` to set (default: none)
144162
rustc-args = [ "--example-rustc-arg" ]
163+
164+
# Additional `RUSTDOCFLAGS` to set (default: none)
145165
rustdoc-args = [ "--example-rustdoc-arg" ]</pre></code>
146166

147167
<h4>Version</h4>

0 commit comments

Comments
 (0)