From 8b6f78f54668e2e1ec97e0011632a8e7077676a6 Mon Sep 17 00:00:00 2001 From: Michael Zhang Date: Tue, 16 Feb 2021 04:52:42 -0600 Subject: [PATCH] actions --- .github/workflows/doc.yml | 27 +++++++++++++++++++++++++++ docs/.gitignore | 1 + docs/book.toml | 6 ++++++ docs/src/SUMMARY.md | 3 +++ docs/src/chapter_1.md | 1 + 5 files changed, 38 insertions(+) create mode 100644 .github/workflows/doc.yml create mode 100644 docs/.gitignore create mode 100644 docs/book.toml create mode 100644 docs/src/SUMMARY.md create mode 100644 docs/src/chapter_1.md diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..50ff6b9 --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,27 @@ +on: [push] + +name: CI + +jobs: + build_and_test: + name: Rust project + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + - run: | + cargo install mdbook + mdbook build docs -d $(pwd)/public + + cargo test + cargo doc --workspace --no-deps + cp -r target/doc public/api + - name: deploy + uses: JamesIves/github-pages-deploy-action@4.0.0 + with: + branch: gh-pages + folder: public + +# vim: set sw=2 tw=2 : diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..6aada2f --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Michael Zhang"] +language = "en" +multilingual = false +src = "src" +title = "Panorama" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000..7390c82 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Chapter 1](./chapter_1.md) diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/docs/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1