Fix docs.rs builds (#3665)

* fix docs.rs builds

* add workflow to check docs-rs builds before release
This commit is contained in:
Scott Mabin 2025-06-20 09:04:17 +01:00 committed by GitHub
parent b98631570f
commit c19f5fd159
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions

View File

@ -174,3 +174,15 @@ jobs:
source: "docs/"
strip_components: 1 # remove the docs prefix
overwrite: true
docsrs:
runs-on: ubuntu-latest
if: ${{ (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'release-pr')) }}
steps:
- uses: actions/checkout@v4
with:
repository: esp-rs/esp-hal
- name: Install cargo-docs-rs
run: cargo install cargo-docs-rs --locked
- name: Run cargo-docs-rs
run: cd esp-hal && cargo docs-rs

View File

@ -15,7 +15,7 @@ exclude = [ "api-baseline", "MIGRATING-*", "CHANGELOG.md" ]
[package.metadata.docs.rs]
default-target = "riscv32imac-unknown-none-elf"
features = ["esp32c6"]
features = ["esp32c6", "unstable"]
rustdoc-args = ["--cfg", "docsrs"]
[lib]