Merge pull request 'update documentation build' (#99) from update-doc…

…s-build into main

Reviewed-on: https://egit.irs.uni-stuttgart.de/rust/spacepackets/pulls/99

.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

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

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 <[email protected]>"]
@@ -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"]

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') {

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.

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))]