From 51f21fee434d70c8cf1717fe77e57d2a174905a5 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 26 Jun 2024 22:58:12 +0200 Subject: [PATCH] update doc build settings --- .github/workflows/ci.yml | 2 +- automation/Jenkinsfile | 2 +- va108xx-hal/Cargo.toml | 2 +- va108xx-hal/src/lib.rs | 2 +- va108xx/Cargo.toml | 2 +- va108xx/src/lib.rs | 2 +- vorago-reb1/Cargo.toml | 2 +- vorago-reb1/src/lib.rs | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c7f068b..b23fa31 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -39,7 +39,7 @@ jobs: steps: - uses: actions/checkout@v4 - uses: dtolnay/rust-toolchain@nightly - - run: cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' + - run: RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features clippy: name: Clippy diff --git a/automation/Jenkinsfile b/automation/Jenkinsfile index 6ac6a4e..832d6a0 100644 --- a/automation/Jenkinsfile +++ b/automation/Jenkinsfile @@ -25,7 +25,7 @@ pipeline { stage('Docs') { steps { sh """ - cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' + RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features """ } } diff --git a/va108xx-hal/Cargo.toml b/va108xx-hal/Cargo.toml index 4f0d4cf..415cbe4 100644 --- a/va108xx-hal/Cargo.toml +++ b/va108xx-hal/Cargo.toml @@ -45,4 +45,4 @@ rt = ["va108xx/rt"] [package.metadata.docs.rs] all-features = true -rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] +rustdoc-args = ["--generate-link-to-definition"] diff --git a/va108xx-hal/src/lib.rs b/va108xx-hal/src/lib.rs index f2dea5c..71857ec 100644 --- a/va108xx-hal/src/lib.rs +++ b/va108xx-hal/src/lib.rs @@ -1,5 +1,5 @@ #![no_std] -#![cfg_attr(docs_rs, feature(doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use va108xx; pub use va108xx as pac; diff --git a/va108xx/Cargo.toml b/va108xx/Cargo.toml index b946f75..7e434c1 100644 --- a/va108xx/Cargo.toml +++ b/va108xx/Cargo.toml @@ -24,4 +24,4 @@ rt = ["cortex-m-rt/device"] [package.metadata.docs.rs] all-features = true -rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] +rustdoc-args = ["--generate-link-to-definition"] diff --git a/va108xx/src/lib.rs b/va108xx/src/lib.rs index 388c5b6..098df25 100644 --- a/va108xx/src/lib.rs +++ b/va108xx/src/lib.rs @@ -4,7 +4,7 @@ svd2rust release can be generated by cloning the svd2rust [repository], checking #![allow(non_snake_case)] #![no_std] // Manually inserted. -#![cfg_attr(docs_rs, feature(doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] use core::marker::PhantomData; use core::ops::Deref; #[doc = r"Number available in the NVIC for configuring priority"] diff --git a/vorago-reb1/Cargo.toml b/vorago-reb1/Cargo.toml index 60ff83a..4a833f6 100644 --- a/vorago-reb1/Cargo.toml +++ b/vorago-reb1/Cargo.toml @@ -38,4 +38,4 @@ version = "0.1" [package.metadata.docs.rs] all-features = true -rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] +rustdoc-args = ["--generate-link-to-definition"] diff --git a/vorago-reb1/src/lib.rs b/vorago-reb1/src/lib.rs index e51be97..bc44aae 100644 --- a/vorago-reb1/src/lib.rs +++ b/vorago-reb1/src/lib.rs @@ -1,5 +1,5 @@ #![no_std] -#![cfg_attr(docs_rs, feature(doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub mod button; pub mod leds;