Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,39 @@ jobs:
run: |
bash ./scripts/ci_post_run_benchmark.sh

documentation-book:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install Rust
run: |
rustup update ${{ matrix.rust }} --no-self-update
rustup default ${{ matrix.rust }}
rustup target add wasm32-unknown-unknown

- name: Install mdbook
run: |
cargo install mdbook --version 0.4.48
cargo install mdbook-admonish --version 1.19.0

- name: Build book
run: |
cd docs
mdbook-admonish install
mdbook build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/book

checks-pass:
# Always run this job!
if: always()
needs: [build, examples, benchmark]
needs: [build, examples, benchmark, documentation-book]
runs-on: ubuntu-latest
steps:
- name: check build result
Expand All @@ -145,3 +174,6 @@ jobs:
- name: check benchmark result
if: ${{ needs.benchmark.result != 'success' }}
run: exit 1
- name: check documentation-book result
if: ${{ needs.documentation-book.result != 'success' }}
run: exit 1
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.css
book
1 change: 1 addition & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ additional-css = ["./mdbook-admonish.css"]
[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "3.0.3" # do not edit: managed by `mdbook-admonish install`