Updates for docs #8

Merged
muellerr merged 2 commits from docs-updates into main 2024-06-25 16:25:23 +02:00
8 changed files with 14 additions and 4 deletions

View File

@ -39,7 +39,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@nightly - 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: clippy:
name: Clippy name: Clippy

View File

@ -25,7 +25,7 @@ pipeline {
stage('Docs') { stage('Docs') {
steps { steps {
sh """ 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
""" """
} }
} }

View File

@ -37,3 +37,7 @@ default = ["rt", "revb"]
rt = ["va416xx/rt"] rt = ["va416xx/rt"]
defmt = ["dep:defmt", "fugit/defmt"] defmt = ["dep:defmt", "fugit/defmt"]
revb = [] revb = []
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--generate-link-to-definition"]

View File

@ -1,4 +1,5 @@
#![no_std] #![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#[cfg(test)] #[cfg(test)]
extern crate std; extern crate std;

View File

@ -26,4 +26,4 @@ rt = ["cortex-m-rt/device"]
[package.metadata.docs.rs] [package.metadata.docs.rs]
all-features = true all-features = true
rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] rustdoc-args = ["--generate-link-to-definition"]

View File

@ -4,7 +4,7 @@ svd2rust release can be generated by cloning the svd2rust [repository], checking
#![allow(non_snake_case)] #![allow(non_snake_case)]
#![no_std] #![no_std]
// Manually inserted. // Manually inserted.
#![cfg_attr(docs_rs, feature(doc_auto_cfg))] #![cfg_attr(docsrs, feature(doc_auto_cfg))]
use core::marker::PhantomData; use core::marker::PhantomData;
use core::ops::Deref; use core::ops::Deref;
#[doc = r"Number available in the NVIC for configuring priority"] #[doc = r"Number available in the NVIC for configuring priority"]

View File

@ -28,3 +28,7 @@ features = ["out_f32"]
[features] [features]
rt = ["va416xx-hal/rt"] rt = ["va416xx-hal/rt"]
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--generate-link-to-definition"]

View File

@ -1,5 +1,6 @@
//! Board support crate for the VORAGO PEB1 board. //! Board support crate for the VORAGO PEB1 board.
#![no_std] #![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
pub use lis2dh12; pub use lis2dh12;