File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ name : Documentation
2+
3+ on :
4+ push :
5+ branches : [ main ]
6+ pull_request :
7+ branches : [ main ]
8+
9+ jobs :
10+ docs :
11+ name : Build Documentation
12+ runs-on : ubuntu-latest
13+ steps :
14+ - uses : actions/checkout@v4
15+
16+ - name : Install Rust
17+ uses : dtolnay/rust-toolchain@stable
18+
19+ - name : Cache dependencies
20+ uses : actions/cache@v3
21+ with :
22+ path : |
23+ ~/.cargo/registry
24+ ~/.cargo/git
25+ target
26+ key : ${{ runner.os }}-docs-cargo-${{ hashFiles('**/Cargo.lock') }}
27+
28+ - name : Build documentation
29+ run : cargo doc --all-features --no-deps
30+
31+ - name : Deploy to GitHub Pages
32+ if : github.ref == 'refs/heads/main'
33+ uses : peaceiris/actions-gh-pages@v3
34+ with :
35+ github_token : ${{ secrets.GITHUB_TOKEN }}
36+ publish_dir : ./target/doc
37+ destination_dir : docs
Original file line number Diff line number Diff line change 44
55[ ![ Build Status] ( https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/ci.yml?branch=main )] ( https://github.com/aimdb-dev/aimdb/actions )
66[ ![ Security Audit] ( https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/security.yml?branch=main&label=security )] ( https://github.com/aimdb-dev/aimdb/actions )
7+ [ ![ Documentation] ( https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/docs.yml?branch=main&label=docs )] ( https://github.com/aimdb-dev/aimdb/actions )
78[ ![ Crates.io] ( https://img.shields.io/crates/v/aimdb.svg )] ( https://crates.io/crates/aimdb )
89[ ![ License] ( https://img.shields.io/badge/license-Apache%202.0-blue.svg )] ( LICENSE )
910[ ![ Rust] ( https://img.shields.io/badge/rust-stable-orange.svg )] ( https://www.rust-lang.org )
You can’t perform that action at this time.
0 commit comments