-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
chore(rust): fix docs build and add to CI #9904
Conversation
There's already a workflow for this - |
Doesn't that one build and publishes the docs? This one tests them and fails CI if they fail. The release today failed building docs. |
It's a combination. The workflow builds the docs and fails if they cannot be built. Then if it's on the main branch, it publishes the result. I guess we should add the full |
The point is, it should not fail on main, but on the PR. If a PR introduces a failing doctest, it should not be merged. The docstest on main, doesn't have to run. At that point, we should be certain the docs are correct and just publish them. |
That's what it does. Just change this: polars/.github/workflows/docs-rust.yml Lines 32 to 35 in 6729224
To: - name: Build Rust documentation
env:
RUSTDOCFLAGS: --cfg docsrs -D warnings
working-directory: polars
run: make doctest |
Ok, will do! |
You'll probably have to fix a few warnings though - mostly links that need to be proper hyperlinks, and a few feature gates. I was just looking at that locally 😄 |
No description provided.