Skip to content

Commit 44076ce

Browse files
authored
Merge pull request #196 from frewsxcv/frewsxcv-metadata
Document docs.rs metadata on the 'about' page.
2 parents 8a31bf7 + caef39d commit 44076ce

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

templates/about.hbs

+18
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,24 @@
9999
</tbody>
100100
</table>
101101

102+
<h4>Metadata for custom builds</h4>
103+
104+
<p>You can customize docs.rs builds by defining <code>[package.metadata.docs.rs]</code> table in your crates' `Cargo.toml`.</p>
105+
106+
<p>An example metadata:</p>
107+
108+
<pre><code>[package]
109+
name = "test"
110+
111+
[package.metadata.docs.rs]
112+
features = [ "feature1", "feature2" ]
113+
all-features = true
114+
no-default-features = true
115+
default-target = "x86_64-unknown-linux-gnu"
116+
rustc-args = [ "--example-rustc-arg" ]
117+
rustdoc-args = [ "--example-rustdoc-arg" ]
118+
dependencies = [ "example-system-dependency" ]</pre></code>
119+
102120
<h4>Version</h4>
103121
<p>Currently running Docs.rs version is: <strong>{{cratesfyi_version}}</strong>
104122

0 commit comments

Comments
 (0)