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.

Sign up for GitHub

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

ci: Add build-doc job to test building docs. #227

Merged
merged 2 commits into from
Jul 20, 2024
Merged

ci: Add build-doc job to test building docs. #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3f10f
ci: Add `build-doc` job to test building docs.
waywardmonkeys Jul 17, 2024
da5775f
fix docs warning.
sebcrozet Jul 20, 2024
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/parry-ci-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,15 @@ jobs:
run: xargo build --verbose --no-default-features --features required-features --target=x86_64-unknown-linux-gnu;
- name: build thumbv7em-none-eabihf
run: xargo build --verbose --no-default-features --features required-features --target=thumbv7em-none-eabihf;
build-doc:
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: -D warnings
steps:
- uses: actions/checkout@v4
- name: install stable Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- name: cargo doc
run: cargo doc --workspace --features bytemuck-serialize,serde-serialize,rkyv-serialize,parallel --no-deps --document-private-items
Copy link
Contributor

@Vrixyz Vrixyz Jul 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

features addition is a good addition compared to #224

2 changes: 1 addition & 1 deletion src/shape/shape.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ pub trait Shape: RayCast + PointQuery + DowncastSync {
///
/// In some cases, the resulting shape doesn’t have the same type as Self. For example,
/// if a non-uniform scale is provided and Self as a [`Ball`], then the result will be discretized
/// (based on the `num_subdivisions` parameter) as a [`ConvexPolyhedron`] (in 3D) or [`ConvexPolygon`] (in 2D).
/// (based on the `num_subdivisions` parameter) as a `ConvexPolyhedron` (in 3D) or `ConvexPolygon` (in 2D).
#[cfg(feature = "std")]
fn scale_dyn(&self, scale: &Vector<Real>, num_subdivisions: u32) -> Option<Box<dyn Shape>>;

Expand Down