Skip to content

Include published_docs cfg while building the docs. #12

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

Jump to bottom
Merged
merged 2 commits into from
May 20, 2025
Merged

Include published_docs cfg while building the docs. #12

merged 2 commits into from
May 20, 2025

Conversation

Yarwin
Copy link
Contributor

@Yarwin Yarwin commented May 15, 2025

@Bromeon
Copy link
Member

Bromeon commented May 15, 2025 •
edited
Loading

Thanks a lot! 👍

Regarding CI:

This is a scheduled Ubuntu 20.04 retirement. Ubuntu 20.04 LTS runner will be removed on 2025-04-15. For more details, see actions/runner-images#11101

Could you update all ubuntus to ubuntu-24.04, in a separate commit or PR? Including those that are currently on ubuntu-latest.

(I'd rather not use ubuntu-latest because they tended to introduce breaking changes in the past, and it's much harder to debug than a conscious runner update).

Bromeon
Bromeon reviewed May 15, 2025
View reviewed changes
documentation/put.sh Outdated
Comment on lines 94 to 96
export RUSTFLAGS="--cfg published_docs -A unused_imports -A dead_code -A unexpected_cfgs -A unused_doc_comments -A unused_attributes"
# export RUSTDOCFLAGS=...
# All doc(cfg(...)) attributes are gated behind `published_docs` cfg – therefore it must be supplied as well.
export RUSTDOCFLAGS="--cfg published_docs"
Copy link
Member

Choose a reason for hiding this comment

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

Do we then still need to provide --cfg published_docs to RUSTFLAGS?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, because RUSTDOCFLAGS is propagated only to godot crate (and we need it for codegen and whatnot: godot-rust/gdext#1163 (comment)

@Bromeon Bromeon added the correction Correct a mistake in the website label May 15, 2025
Yarwin added 2 commits May 15, 2025 13:02
@Yarwin
Include published_docs cfg while building the docs as well.
66b292f
@Yarwin
Switch runner to ubuntu-24.04 (not ubuntu-latest because they tended …
b3c3662 
…to introduce breaking changes in the past, and it's much harder to debug than a conscious runner update)
@Yarwin Yarwin force-pushed the supply-published-docs-cfg branch from ddf8d10 to b3c3662 Compare May 15, 2025 11:05
@Bromeon Bromeon merged commit 7e1e52a into godot-rust:master May 20, 2025
3 checks passed
@Bromeon
Copy link
Member

Bromeon commented May 20, 2025

Thank you! 👍

@Bromeon Bromeon added ci-cd Website deployment, doc generation CI/CD and removed correction Correct a mistake in the website labels Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bromeon Bromeon Bromeon left review comments

Assignees
No one assigned
Labels
ci-cd Website deployment, doc generation CI/CD
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs don't inform that given class is gated behind experimental-godot-api feature
2 participants
@Yarwin @Bromeon