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

Add tests for the generated documentation #53

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

antalsz
Copy link
Contributor

@antalsz antalsz commented Jul 9, 2024

Closes #52. Leaving as draft because it's not clear the best way to do this. Extends #51.

This enables easier manual testing with `cargo expand`, and will enable easier
snapshot testing later.
We have to specify a specific OS target because until PyO3 v0.22, PyO3
transitively depends on the [rust-ctor](https://crates.io/crates/ctor) crate,
which generates different output on different OSes.  Once we're doing *that*, we
have to specify a specific Python ABI so that PyO3 doesn't get alarmed about
cross-compilation.  This is all a minor headache.

One concern about this is that everyone testing locally has to run `rustup
target add x864_64-unknown-linuxgnu`.  CI doesn't, because I deliberately picked
the triple that was running on CI, but any local development that isn't on that
OS does.  Is this worth it?
@antalsz antalsz force-pushed the 52-add-documentation-tests branch from 4c1ad71 to dcda90e Compare July 9, 2024 00:35
@antalsz antalsz force-pushed the 52-add-documentation-tests branch from 33db30c to 5ddd5e5 Compare July 9, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add test cases for the generated documentation
1 participant