diff options
| -rw-r--r-- | book/en/src/preface.md | 5 | ||||
| -rw-r--r-- | ci/after-success.sh | 11 | ||||
| -rw-r--r-- | ci/install.sh | 23 | ||||
| -rw-r--r-- | redirect.html | 6 |
4 files changed, 30 insertions, 15 deletions
diff --git a/book/en/src/preface.md b/book/en/src/preface.md index 15aaea5c..1728062b 100644 --- a/book/en/src/preface.md +++ b/book/en/src/preface.md @@ -11,7 +11,10 @@ There is a translation of this book in [Russian]. [Russian]: ../ru/index.html -**HEADS UP** This is an **alpha** pre-release; there may be breaking changes in +This is the documentation of v0.5.x of RTFM; for the documentation of version +v0.4.x go [here](../../0.4/book/en). + +**HEADS UP** This is a **beta** pre-release; there may be breaking changes in the API and semantics before a proper release is made. {{#include ../../../README.md:5:44}} diff --git a/ci/after-success.sh b/ci/after-success.sh index 3aaa8348..54bea2c0 100644 --- a/ci/after-success.sh +++ b/ci/after-success.sh @@ -11,14 +11,17 @@ main() { # build latest docs cp -r target/doc $td/api + sed 's|URL|rtfm/index.html|g' redirect.html > $td/api/index.html + mkdir $td/book/ - cp redirect.html $td/index.html + sed 's|URL|book/en|g' redirect.html > $td/index.html for lang in ${langs[@]}; do ( cd book/$lang && mdbook build ) cp -r book/$lang/book $td/book/$lang cp LICENSE-* $td/book/$lang/ done + local root=$(pwd) # build older docs for ver in ${vers[@]}; do local prefix=${ver%.*} @@ -28,18 +31,24 @@ main() { curl -L https://github.com/rtfm-rs/cortex-m-rtfm/archive/v${ver}.tar.gz | tar xz --strip-components 1 -C $src pushd $src + rm -f .cargo/config cargo doc || cargo doc --features timer-queue cp -r target/doc $td/$prefix/api + sed 's|URL|rtfm/index.html|g' $root/redirect.html > $td/$prefix/api/index.html for lang in ${langs[@]}; do ( cd book/$lang && mdbook build ) cp -r book/$lang/book $td/$prefix/book/$lang cp LICENSE-* $td/$prefix/book/$lang/ done + sed 's|URL|book/en|g' $root/redirect.html > $td/$prefix/index.html popd rm -rf $src done + # forward CNAME file + cp CNAME $td/ + mkdir ghp-import curl -Ls https://github.com/davisp/ghp-import/archive/master.tar.gz | tar --strip-components 1 -C ghp-import -xz diff --git a/ci/install.sh b/ci/install.sh index 6f8d8151..cbc2125b 100644 --- a/ci/install.sh +++ b/ci/install.sh @@ -1,22 +1,25 @@ set -euxo pipefail main() { - if [ $TARGET = x86_64-unknown-linux-gnu ]; then - ( cd .. && cargo install microamp-tools --version 0.1.0-alpha.2 -f ) - rustup target add thumbv6m-none-eabi thumbv7m-none-eabi - fi + # these are not needed for doc builds + if [ $TRAVIS_BRANCH != master ] || [ $TRAVIS_PULL_REQUEST != false ]; then + if [ $TARGET = x86_64-unknown-linux-gnu ]; then + ( cd .. && cargo install microamp-tools --version 0.1.0-alpha.2 -f ) + rustup target add thumbv6m-none-eabi thumbv7m-none-eabi + fi + + rustup target add $TARGET - rustup target add $TARGET + mkdir qemu + curl -L https://github.com/japaric/qemu-bin/raw/master/14.04/qemu-system-arm-2.12.0 > qemu/qemu-system-arm + chmod +x qemu/qemu-system-arm - mkdir qemu - curl -L https://github.com/japaric/qemu-bin/raw/master/14.04/qemu-system-arm-2.12.0 > qemu/qemu-system-arm - chmod +x qemu/qemu-system-arm + pip install linkchecker --user + fi # install mdbook curl -LSfs https://japaric.github.io/trust/install.sh | \ sh -s -- --git rust-lang-nursery/mdbook --tag v0.3.1 - - pip install linkchecker --user } main diff --git a/redirect.html b/redirect.html index 58f1a72f..b832e0b1 100644 --- a/redirect.html +++ b/redirect.html @@ -3,14 +3,14 @@ <html lang="en-US"> <head> <meta charset="UTF-8"> - <meta http-equiv="refresh" content="0; url=https://rtfm-rs.github.io/cortex-m-rtfm/book/en/"> + <meta http-equiv="refresh" content="0; url=URL"> <script type="text/javascript"> - window.location.href = "https://rtfm-rs.github.io/cortex-m-rtfm/book/en/" + window.location.href = "URL" </script> <title>Page Redirection</title> </head> <body> <!-- Note: don't tell people to `click` the link, just tell them that it is a link. --> - If you are not redirected automatically, follow this <a href='https://rtfm-rs.github.io/cortex-m-rtfm/book/en/'>link to example</a>. + If you are not redirected automatically, follow this <a href='URL'>link</a>. </body> </html> |