From a5918bfd4a2b169c28f321192efe2deb8cc6f00e Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 25 Jun 2024 16:07:07 +0200 Subject: [PATCH] update documentation build --- .github/workflows/ci.yml | 2 +- CHANGELOG.md | 4 ++++ Cargo.toml | 4 ++-- automation/Jenkinsfile | 4 +++- release-checklist.md | 4 +++- src/lib.rs | 2 +- 6 files changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8308dfe..7e78720 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -61,7 +61,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/CHANGELOG.md b/CHANGELOG.md index a7bfe3d..4114731 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). # [unreleased] +# [v0.11.3] 2024-06-25 + +- Minor documentation build updates. + # [v0.11.2] 2024-05-19 - Bumped MSRV to 1.68.2 diff --git a/Cargo.toml b/Cargo.toml index 5de4485..f069764 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "spacepackets" -version = "0.11.2" +version = "0.11.3" edition = "2021" rust-version = "1.68.2" authors = ["Robin Mueller "] @@ -67,4 +67,4 @@ defmt = ["dep:defmt"] [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/automation/Jenkinsfile b/automation/Jenkinsfile index be6696c..bfc6c92 100644 --- a/automation/Jenkinsfile +++ b/automation/Jenkinsfile @@ -21,7 +21,9 @@ pipeline { } stage('Docs') { steps { - sh 'cargo +nightly doc --all-features' + sh """ + RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features + """ } } stage('Rustfmt') { diff --git a/release-checklist.md b/release-checklist.md index 32833f5..b8dea5e 100644 --- a/release-checklist.md +++ b/release-checklist.md @@ -4,7 +4,9 @@ Checklist for new releases # Pre-Release 1. Make sure any new modules are documented sufficiently enough and check docs with - `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`. + `RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features --open` + or `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docsrs" --generate-link-to-definition"]' --open` + (was problematic on more recent nightly versions). 2. Bump version specifier in `Cargo.toml`. 3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new `unreleased` section. diff --git a/src/lib.rs b/src/lib.rs index 72f8cb3..2b17e9b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -55,7 +55,7 @@ //! println!("{:x?}", &ccsds_buf[0..6]); //! ``` #![no_std] -#![cfg_attr(docs_rs, feature(doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] #[cfg(feature = "alloc")] extern crate alloc; #[cfg(any(feature = "std", test))] -- 2.43.0