Add documentation #30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| pull_request: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| muscat: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Rust toolchain | |
| uses: actions-rust-lang/setup-rust-toolchain@v1 | |
| with: | |
| components: "clippy, rustfmt" | |
| - name: Build | |
| run: cargo build --verbose | |
| - name: Run tests | |
| run: cargo test --verbose | |
| - name: Check formatting | |
| run: cargo fmt --check | |
| - name: Lint with Clippy | |
| run: cargo clippy -- -Dwarnings | |
| - name: Build examples | |
| run: cargo build --examples | |
| - name: Build benchmarks | |
| run: cargo bench --no-run | |
| muscatpy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Rust toolchain | |
| uses: actions-rust-lang/setup-rust-toolchain@v1 | |
| with: | |
| components: "clippy, rustfmt" | |
| cache-workspaces: "muscatpy -> target" | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Build wheels | |
| uses: PyO3/maturin-action@v1 | |
| with: | |
| command: build | |
| args: --manifest-path muscatpy/Cargo.toml --release | |
| - name: Check formatting | |
| run: cargo fmt --manifest-path muscatpy/Cargo.toml --check | |
| - name: Lint with Clippy | |
| run: cargo clippy --manifest-path muscatpy/Cargo.toml -- -Dwarnings |