diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2023-05-23 06:26:28 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-23 06:26:28 +0000 |
| commit | 62162241d4c7d82dfbb310113f7525d134cfde9b (patch) | |
| tree | 4346cbe248835eba381003d8592248102028dac5 /check-book.sh | |
| parent | 21b0d97e17922c023a3b5d8148a414d4277f7b87 (diff) | |
| parent | 9fa073f7936782bddf5d02b7b1949032e84de1bd (diff) | |
Merge #741
741: Docs 2 r=korken89 a=datdenkikniet
Working on the migration guide and other docs
TODO:
- [x] Migration guide
- [x] Hardcoded examples should link to example code that is tested (this was already done, AFAICT)
- [x] Address #699
- [x] Discuss: should we remove references to non-v2, apart from the migration guide and link to the book for v1? (Off-github conclusion: yes)
- [x] RTIC {vs,and} Embassy (important: distinction between embassy runtime & HALs)
- [x] More descriptive docs on how to implement & PR implementations of `Monotonic` to `rtic-monotonics`
Co-authored-by: datdenkikniet <jcdra1@gmail.com>
Diffstat (limited to 'check-book.sh')
| -rwxr-xr-x | check-book.sh | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/check-book.sh b/check-book.sh new file mode 100755 index 0000000..22289fe --- /dev/null +++ b/check-book.sh @@ -0,0 +1,18 @@ +#!/bin/sh + +set -e + +cd book/en/ +mdbook build +cd ../../ + +cargo doc --features thumbv7-backend + +mkdir -p book-target/book/ +cp -r book/en/book/ book-target/book/en/ +cp LICENSE-* book-target/book/en +cp -r target/doc/ book-target/api/ + +lychee --offline --format detailed book-target/book/en/ + +rm -rf book-target/
\ No newline at end of file |