Implemented an interface to BatSat #231
Workflow file for this run
This file contains 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: Docs | |
on: | |
push: | |
branches: [ "main", "next-major" ] | |
pull_request: | |
branches: [ "main", "next-major" ] | |
env: | |
CARGO_TERM_COLOR: always | |
RUSTDOCFLAGS: "-Dwarnings" | |
jobs: | |
doc: | |
name: Docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout sources | |
uses: actions/checkout@v4 | |
with: | |
submodules: "recursive" | |
- name: Install stable toolchain | |
uses: dtolnay/rust-toolchain@stable | |
- uses: Swatinem/rust-cache@v2 | |
- name: Run cargo doc | |
run: cargo doc --workspace --verbose --no-deps --features=all | |
- name: Check READMEs | |
run: | | |
cargo install cargo-rdme | |
return=true | |
if ! cargo rdme --check; then | |
echo "failed for main crate" | |
return=false | |
fi | |
for dir in tools cadical kissat minisat glucose ipasir capi pyapi; do | |
cd ${dir} | |
if ! cargo rdme --check; then | |
echo "failed for ${dir}" | |
return=false | |
fi | |
cd .. | |
done | |
${return} |