Merge pull request 'update doc build settings' (#10) from update-doc-settings into main
All checks were successful
Rust/va108xx-rs/pipeline/head This commit looks good

Reviewed-on: #10
This commit is contained in:
Robin Müller 2024-06-26 23:05:30 +02:00
commit abb78c2682
8 changed files with 8 additions and 8 deletions

View File

@ -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

View File

@ -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
"""
}
}

View File

@ -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"]

View File

@ -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;

View File

@ -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"]

View File

@ -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"]

View File

@ -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"]

View File

@ -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;