Merge #234

234: fix gh-pages build r=korken89 a=japaric

this should build the latest docs and the docs for v0.4.x after successful merges

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

Cargo.toml

@@ -5,13 +5,13 @@ authors = [
 ]
 categories = ["concurrency", "embedded", "no-std"]
 description = "Real Time For the Masses (RTFM): a concurrency framework for building real time systems"
-documentation = "https://japaric.github.io/cortex-m-rtfm/book/en"
+documentation = "https://rtfm-rs.github.io/cortex-m-rtfm/book/en"
 edition = "2018"
 keywords = ["arm", "cortex-m"]
 license = "MIT OR Apache-2.0"
 name = "cortex-m-rtfm"
 readme = "README.md"
-repository = "https://github.com/japaric/cortex-m-rtfm"
+repository = "https://github.com/rtfm-rs/cortex-m-rtfm"
 version = "0.5.0-beta.1"
 
 [lib]
@@ -48,7 +48,7 @@ required-features = ["__v7"]
 [dependencies]
 cortex-m = "0.6.0"
 cortex-m-rtfm-macros = { path = "macros" }
-rtfm-core = { git = "https://github.com/japaric/rtfm-core" }
+rtfm-core = { git = "https://github.com/rtfm-rs/rtfm-core" }
 cortex-m-rt = "0.6.9"
 heapless = "0.5.0"
 

ci/after-success.sh

@@ -2,20 +2,44 @@ set -euxo pipefail
 
 main() {
     local langs=( en ru )
+    local vers=( 0.4.3 )
 
     rm -f .cargo/config
-    cargo doc --features timer-queue
+    cargo doc
 
     local td=$(mktemp -d)
+
+    # build latest docs
     cp -r target/doc $td/api
     mkdir $td/book/
-    cp redirect.html $td/book/index.html
+    cp 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
 
+    # build older docs
+    for ver in ${vers[@]}; do
+        local prefix=${ver%.*}
+
+        mkdir -p $td/$prefix/book
+        local src=$(mktemp -d)
+        curl -L https://github.com/rtfm-rs/cortex-m-rtfm/archive/v${ver}.tar.gz | tar xz --strip-components 1 -C $src
+
+        pushd $src
+        cargo doc || cargo doc --features timer-queue
+        cp -r target/doc $td/$prefix/api
+        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
+        popd
+
+        rm -rf $src
+    done
+
     mkdir ghp-import
     curl -Ls https://github.com/davisp/ghp-import/archive/master.tar.gz |
         tar --strip-components 1 -C ghp-import -xz
@@ -23,8 +47,7 @@ main() {
     ./ghp-import/ghp_import.py $td
 
     set +x
-    # NOTE push documentation to a different repository
+    git push -fq https://$GH_TOKEN@github.com/rtfm-rs/cortex-m-rtfm.git gh-pages && echo OK
-    git push -fq https://$GH_TOKEN@github.com/japaric/rtfm5.git gh-pages && echo OK
 
     rm -rf $td
 }

macros/Cargo.toml

@@ -2,13 +2,13 @@
 authors = ["Jorge Aparicio <jorge@japaric.io>"]
 categories = ["concurrency", "embedded", "no-std"]
 description = "Procedural macros of the cortex-m-rtfm crate"
-documentation = "https://japaric.github.io/cortex-m-rtfm/api/cortex_m_rtfm"
+documentation = "https://rtfm-rs.github.io/cortex-m-rtfm/api/cortex_m_rtfm"
 edition = "2018"
 keywords = ["arm", "cortex-m"]
 license = "MIT OR Apache-2.0"
 name = "cortex-m-rtfm-macros"
 readme = "../README.md"
-repository = "https://github.com/japaric/cortex-m-rtfm"
+repository = "https://github.com/rtfm-rs/cortex-m-rtfm"
 version = "0.5.0-alpha.1"
 
 [lib]
@@ -20,7 +20,7 @@ quote = "1"
 syn = "1"
 
 [dependencies.rtfm-syntax]
-git = "https://github.com/japaric/rtfm-syntax"
+git = "https://github.com/rtfm-rs/rtfm-syntax"
 
 [features]
 heterogeneous = []

macros/src/lib.rs

@@ -89,9 +89,9 @@ mod tests;
 ///
 /// - `resources: <fn-name>::Resources`. A `struct` that contains all the resources that can be
 /// accessed from this context. Each field is a different resource; each resource may appear as a
-/// reference (`&[mut]-`) or as proxy structure that implements the [`rftm::Mutex`] trait.
+/// reference (`&[mut]-`) or as proxy structure that implements the [`rftm::Mutex`][rtfm-mutex] trait.
 ///
-/// [`rtfm::Mutex`]: ../rtfm/trait.Mutex.html
+/// [rtfm-mutex]: ../rtfm/trait.Mutex.html
 ///
 /// - `schedule: <fn-name>::Schedule`. A `struct` that can be used to schedule *software* tasks.
 ///

redirect.html

@@ -3,14 +3,14 @@
 <html lang="en-US">
     <head>
         <meta charset="UTF-8">
-        <meta http-equiv="refresh" content="0; url=https://japaric.github.io/cortex-m-rtfm/book/en/">
+        <meta http-equiv="refresh" content="0; url=https://rtfm-rs.github.io/cortex-m-rtfm/book/en/">
         <script type="text/javascript">
-            window.location.href = "https://japaric.github.io/cortex-m-rtfm/book/en/"
+            window.location.href = "https://rtfm-rs.github.io/cortex-m-rtfm/book/en/"
         </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://japaric.github.io/cortex-m-rtfm/book/en/'>link to example</a>.
+        If you are not redirected automatically, follow this <a href='https://rtfm-rs.github.io/cortex-m-rtfm/book/en/'>link to example</a>.
     </body>
 </html>