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

Replace dox feature with docsrs attribute #1455

Merged
merged 2 commits into from
Apr 12, 2023

Conversation

AaronErhardt
Copy link
Contributor

Fixes #1454

I think this should be all from the gir side.
I've tested this branch on gtk4-rs and everything looked and worked great so far.

Let me know if I should submit PRs for various gtk-rs crates once this is merged.

@bilelmoussaoui
Copy link
Member

I would also suggest documenting how cargo doc should be ran in the gir book if possible

@GuillaumeGomez
Copy link
Member

So sadly it will require to add a --feature argument when running cargo doc. Not much we can do about it... Really annoyed that cargo still doesn't allow to have doc profile for that.

@bilelmoussaoui
Copy link
Member

So sadly it will require to add a --feature argument when running cargo doc. Not much we can do about it... Really annoyed that cargo still doesn't allow to have doc profile for that.

why a --feature is needed? i thought everything would be handled by the RUSTFLAGS?

@GuillaumeGomez
Copy link
Member

Sorry, you're right. Wrote too quickly. RUSTFLAGS is what I meant.

@sdroege
Copy link
Member

sdroege commented Apr 7, 2023

And generator.py would set that accordingly before calling cargo doc.

@AaronErhardt
Copy link
Contributor Author

Speaking of generator.py, I haven't changed anything on this file so far. As far as I understand it doesn't run cargo doc but expects the user to do so after following all required steps. Should I change something about that?

Everything else should be in place by now, I've pushed an update for the book earlier today.

@sdroege
Copy link
Member

sdroege commented Apr 7, 2023

Oh right. But we set RUSTFLAGS for that already anyway so adding just one more thing is not a problem. Currently we have to set RUSTFLAGS=-Z unstable-options at least.

@AaronErhardt
Copy link
Contributor Author

Is there still anything missing in this PR?

@sdroege
Copy link
Member

sdroege commented Apr 12, 2023

@AaronErhardt Once merged, will you create PRs for gtk-rs-core and gtk4-rs at least to update accordingly?

@AaronErhardt
Copy link
Contributor Author

Sure

@sdroege
Copy link
Member

sdroege commented Apr 12, 2023

Great, then let's get this in :) I can take care of gstreamer-rs once the others are in.

@sdroege sdroege merged commit 210415b into gtk-rs:master Apr 12, 2023
@AaronErhardt AaronErhardt deleted the dox-to-docsrs-attr branch April 12, 2023 17:58
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.

Suggestion: Remove dox feature in favor of rustc args
4 participants