nalgebra icon indicating copy to clipboard operation
nalgebra copied to clipboard

Check documentation in CI

Open Andlon opened this issue 3 years ago • 2 comments

@Patiga suggested in #1144 that we check for broken links with cargo doc in CI. I looked through our CI config, and it looks like we are not running cargo doc at all. It seems like we should run cargo doc and fail the build if there are any substantial issues, such as broken links.

Andlon avatar Sep 12 '22 07:09 Andlon

Happy to put together a PR for this (though I'm still learning my way around Rust).

Are you thinking we'll want just a simple cargo doc or something more involved like cargo +nightly doc --workspace --no-deps? (The --workspace flag seems to need a nightly build and some more config based on a few minutes initial experimentation.)

nihonjinrxs avatar Dec 12 '22 04:12 nihonjinrxs

@sebcrozet pretty sure you can close this ;)

janhohenheim avatar Mar 05 '24 21:03 janhohenheim