Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Try to fix doc build on docs.rs #47

Merged
merged 3 commits into from
Jan 8, 2024
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
12 changes: 12 additions & 0 deletions .github/workflows/check-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ jobs:
- name: Run cargo test suite
run: cargo test --workspace --verbose

doc:
name: Doc
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
- 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

pystubs:
name: Test python stubs
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions cadical/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ fn main() {
};

// Build C++ library
#[cfg(not(doc))]
build(
"https://github.com/arminbiere/cadical.git",
"master",
Expand Down
1 change: 1 addition & 0 deletions glucose/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use std::{env, fs, path::Path, str};
fn main() {
// Build C++ library
// Full commit hash needs to be provided
#[cfg(not(doc))]
build(
"https://github.com/chrjabs/glucose4.git",
"main",
Expand Down
2 changes: 1 addition & 1 deletion glucose/src/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ impl PhaseLit for Glucose {
Ok(())
}

/// Undoes the effect of a call to [`CaDiCaL::phase_lit`]
/// Undoes the effect of a call to [`Glucose::phase_lit`]
fn unphase_var(&mut self, var: Var) -> Result<(), SolverError> {
unsafe { ffi::cglucose4_unphase(self.handle, var.to_ipasir()) };
Ok(())
Expand Down
2 changes: 1 addition & 1 deletion glucose/src/simp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ impl PhaseLit for Glucose {
Ok(())
}

/// Undoes the effect of a call to [`CaDiCaL::phase_lit`]
/// Undoes the effect of a call to [`Glucose::phase_lit`]
fn unphase_var(&mut self, var: Var) -> Result<(), SolverError> {
unsafe { ffi::cglucosesimp4_unphase(self.handle, var.to_ipasir()) };
Ok(())
Expand Down
1 change: 1 addition & 0 deletions kissat/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ fn main() {

// Build C library
// Full commit hash needs to be provided
#[cfg(not(doc))]
build("https://github.com/arminbiere/kissat.git", "master", tag);

let out_dir = env::var("OUT_DIR").unwrap();
Expand Down
1 change: 1 addition & 0 deletions minisat/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use std::{env, fs, path::Path, str};
fn main() {
// Build C++ library
// Full commit hash needs to be provided
#[cfg(not(doc))]
build(
"https://github.com/chrjabs/minisat.git",
"master",
Expand Down
2 changes: 1 addition & 1 deletion minisat/src/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ impl PhaseLit for Minisat {
Ok(())
}

/// Undoes the effect of a call to [`CaDiCaL::phase_lit`]
/// Undoes the effect of a call to [`Minisat::phase_lit`]
fn unphase_var(&mut self, var: Var) -> Result<(), SolverError> {
unsafe { ffi::cminisat_unphase(self.handle, var.to_ipasir()) };
Ok(())
Expand Down
2 changes: 1 addition & 1 deletion minisat/src/simp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ impl PhaseLit for Minisat {
Ok(())
}

/// Undoes the effect of a call to [`CaDiCaL::phase_lit`]
/// Undoes the effect of a call to [`Minisat::phase_lit`]
fn unphase_var(&mut self, var: Var) -> Result<(), SolverError> {
unsafe { ffi::cminisatsimp_unphase(self.handle, var.to_ipasir()) };
Ok(())
Expand Down
Loading