Merge #98

98: ci: run linkchecker r=japaric a=japaric



Co-authored-by: Jorge Aparicio <jorge@japaric.io>

4 files changed, 20 insertions, 2 deletions

diff --git a/README.md b/README.md
index c04be8bb..6c78e8bd 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/ci/install.sh b/ci/install.sh
index 0d5e2218..90007723 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 5fc3ca23..4c86d144 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
 
diff --git a/src/lib.rs b/src/lib.rs
index 74cf96ac..836654cb 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.