From d94d9a6fe18ddf5e5c61adbb1b4a59707e74dbaa Mon Sep 17 00:00:00 2001
From: Camelid Detecting Docs.rs
To recognize Docs.rs from
build.rs
files, you can test for the environment variable DOCS_RS
, e.g.:
{% filter dedent(levels=4) -%}
-
-
+
- if let Ok(_) = std::env::var("DOCS_RS") {
- // ... your code here ...
- }
-
-
{%- endfilter %}
This approach can be helpful if you need dependencies for building the library, but not for building the documentation.
+ if let Ok(_) = std::env::var("DOCS_RS") {
+ // ... your code here ...
+ }
+
You can configure how your crate is built by adding package metadata to your Cargo.toml
, e.g.:
{% filter dedent -%}
-
-
- [package.metadata.docs.rs]
- rustc-args = ["--cfg", "docsrs"]
-
-
+
+ [package.metadata.docs.rs]
+ rustc-args = ["--cfg", "docsrs"]
+
{%- endfilter %}
Here, the compiler arguments are set so that #[cfg(docsrs)]
(not to be confused with #[cfg(doc)]
) can be used for conditional compilation.
This approach is also useful for setting cargo features.
diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html
index fe4fc8b3f..2ed383ae0 100644
--- a/templates/core/about/metadata.html
+++ b/templates/core/about/metadata.html
@@ -14,7 +14,7 @@ The available configuration flags you can customize are:
-{%- include "core/Cargo.toml.example" -%}
+ {%- include "core/Cargo.toml.example" -%}
{%- endblock body %}