From c27efea6b709c5a1b4cf4da98f108c7636993474 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Sat, 3 Nov 2018 19:29:44 +0100 Subject: [PATCH 1/2] fix some links --- README.md | 2 +- src/lib.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c04be8bb92..6c78e8bd7c 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ behave the way you expect please open [an issue]! - Applications must be written using the 2018 edition. -## [User documentation](https://japaric.github.io/cortex-m-rtfm/book/index.html) +## [User documentation](https://japaric.github.io/cortex-m-rtfm/book/) ## [API reference](https://japaric.github.io/cortex-m-rtfm/api/rtfm/index.html) diff --git a/src/lib.rs b/src/lib.rs index 74cf96ac6f..836654cba7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,7 +7,7 @@ //! //! The user level documentation can be found [here]. //! -//! [here]: ../../book/index.html +//! [here]: ../../book/ //! //! Don't forget to check the documentation of the [`#[app]`] attribute, which is the main component //! of the framework. From 9ddf3bf8e79c9bca2a261a14c5adc3ac9472f3c3 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Sat, 3 Nov 2018 19:47:28 +0100 Subject: [PATCH 2/2] run linkchecker --- ci/install.sh | 2 ++ ci/script.sh | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/ci/install.sh b/ci/install.sh index 0d5e2218a2..9000772307 100644 --- a/ci/install.sh +++ b/ci/install.sh @@ -12,6 +12,8 @@ main() { # install mdbook curl -LSfs https://japaric.github.io/trust/install.sh | \ sh -s -- --git rust-lang-nursery/mdbook --tag v0.2.1 + + pip install linkchecker --user } main diff --git a/ci/script.sh b/ci/script.sh index 5fc3ca2380..4c86d144ab 100644 --- a/ci/script.sh +++ b/ci/script.sh @@ -12,6 +12,22 @@ main() { cargo check --target $T cargo check --features timer-queue --target $T + + if [ $TRAVIS_RUST_VERSION = beta ]; then + rm -f .cargo/config + cargo doc --features timer-queue + ( cd book && mdbook build ) + + local td=$(mktemp -d) + cp -r target/doc $td/api + cp -r book/book $td/ + cp LICENSE-* $td/book/ + + linkchecker $td/book/ + linkchecker $td/api/rtfm/ + linkchecker $td/api/cortex_m_rtfm_macros/ + fi + return fi