diff --git a/templates/core/Cargo.toml.example b/templates/core/Cargo.toml.example index 22bf5c74d..d9e2d6a6d 100644 --- a/templates/core/Cargo.toml.example +++ b/templates/core/Cargo.toml.example @@ -1,4 +1,4 @@ -{# The example Cargo.toml used in about.html #} +{~# The example Cargo.toml used in about.html #~} [package] name = "test" diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index cf0c70c65..b4163da67 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -31,12 +31,10 @@
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") {
+ {% filter dedent(levels=3) -%}
+ 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.
@@ -49,10 +47,8 @@
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.