Merge pull request 'update doc build settings' (#10) from update-doc-…

…settings into main Reviewed-on: https://egit.irs.uni-stuttgart.de/rust/va108xx-rs/pulls/10
us-irs · Jun 26, 2024 · abb78c2 · abb78c2
2 parents 6fb3b05 + 51f21fe
commit abb78c2
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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;