diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1529aa7b4..679b76450 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -147,3 +147,14 @@ jobs: with: files: . ignore_files: "target/" + + link-checker: + name: Link Checker + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Check URLs in documentation + uses: lycheeverse/lychee-action@v1.0.4 + with: + args: --verbose --no-progress "*.md" "**/*.md" "**/*.rs" "*.toml" "**/*.toml" -h accept=text/html diff --git a/CHANGELOG.md b/CHANGELOG.md index 3999c31e7..baec06ab4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -327,7 +327,7 @@ let clocks = rcc [#2]: https://github.com/stm32-rs/stm32f3xx-hal/pull/2 [Unreleased]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.6.1...HEAD -[v0.6.0]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.6.0...v0.6.1 +[v0.6.1]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.6.0...v0.6.1 [v0.6.0]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.5.0...v0.6.0 [v0.5.0]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.4.3...v0.5.0 [v0.4.3]: https://github.com/stm32-rs/stm32f3xx-hal/compare/v0.4.2...v0.4.3 diff --git a/src/adc.rs b/src/adc.rs index 8aa5740d0..c3535fdd4 100644 --- a/src/adc.rs +++ b/src/adc.rs @@ -7,7 +7,7 @@ //! It can be built for the STM32F3Discovery running //! `cargo build --example adc --features=stm32f303xc` //! -//! [examples/adc.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/adc.rs +//! [examples/adc.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/adc.rs use crate::{ gpio::Analog, diff --git a/src/can.rs b/src/can.rs index dfc0325e7..c149c633e 100644 --- a/src/can.rs +++ b/src/can.rs @@ -9,7 +9,7 @@ //! //! A usage example of the can peripheral can be found at [examples/can.rs] //! -//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/can.rs +//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/can.rs pub use embedded_hal_can::{self, Filter, Frame, Id, Receiver, Transmitter}; diff --git a/src/dma.rs b/src/dma.rs index 294ed9fde..30acdb050 100644 --- a/src/dma.rs +++ b/src/dma.rs @@ -4,7 +4,7 @@ //! //! An example how to use DMA for serial, can be found at [examples/serial_dma.rs] //! -//! [examples/serial_dma.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/serial_dma.rs +//! [examples/serial_dma.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/serial_dma.rs // To learn about most of the ideas implemented here, check out the DMA section // of the Embedonomicon: https://docs.rust-embedded.org/embedonomicon/dma.html diff --git a/src/gpio.rs b/src/gpio.rs index ab7b8c738..4b56d8b39 100644 --- a/src/gpio.rs +++ b/src/gpio.rs @@ -26,7 +26,7 @@ //! //! [InputPin]: embedded_hal::digital::v2::InputPin //! [OutputPin]: embedded_hal::digital::v2::OutputPin -//! [examples/toggle.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/toggle.rs +//! [examples/toggle.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/toggle.rs use core::convert::Infallible; use core::marker::PhantomData; @@ -163,7 +163,7 @@ macro_rules! gpio { /// /// See [examples/gpio_erased.rs] as an example. /// - /// [examples/gpio_erased.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/gpio_erased.rs + /// [examples/gpio_erased.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/gpio_erased.rs pub struct PXx { i: u8, gpio: Gpio, diff --git a/src/i2c.rs b/src/i2c.rs index ce7eb1c80..c561799b3 100644 --- a/src/i2c.rs +++ b/src/i2c.rs @@ -2,7 +2,7 @@ //! //! A usage example of the i2c peripheral can be found at [examples/i2c_scanner.rs] //! -//! [examples/i2c_scanner.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/i2c_scanner.rs +//! [examples/i2c_scanner.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/i2c_scanner.rs use core::convert::TryFrom; use core::ops::Deref; diff --git a/src/pwm.rs b/src/pwm.rs index c3978420d..b832558f3 100644 --- a/src/pwm.rs +++ b/src/pwm.rs @@ -152,7 +152,7 @@ A usage example can be found at [examples/pwm.rs] - [examples/pwm.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/pwm.rs + [examples/pwm.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/pwm.rs */ use crate::{ diff --git a/src/usb.rs b/src/usb.rs index 404fc420f..a896c9bc3 100644 --- a/src/usb.rs +++ b/src/usb.rs @@ -4,7 +4,7 @@ //! //! See [examples/usb_serial.rs] for a usage example. //! -//! [examples/usb_serial.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/usb_serial.rs +//! [examples/usb_serial.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/usb_serial.rs use crate::pac::{RCC, USB}; use stm32_usbd::UsbPeripheral; diff --git a/src/watchdog.rs b/src/watchdog.rs index ef723014a..c8c989527 100644 --- a/src/watchdog.rs +++ b/src/watchdog.rs @@ -2,7 +2,7 @@ //! //! A usage example of the watchdog can be found at [examples/can.rs] //! -//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.0/examples/can.rs +//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.6.1/examples/can.rs use crate::hal::watchdog::{Watchdog, WatchdogEnable};