Skip to content

chore: make the document of the example able to be previewed#45

Merged
BenjaminBrienen merged 1 commit intobevyengine:mainfrom
kingwingfly:examples/enable_some_feature_gates
Nov 24, 2025
Merged

chore: make the document of the example able to be previewed#45
BenjaminBrienen merged 1 commit intobevyengine:mainfrom
kingwingfly:examples/enable_some_feature_gates

Conversation

@kingwingfly
Copy link
Contributor

Objective

We can only preview the output with things like cargo expand. In this PR, I add some lines about previewing documentation with cargo doc --open.

Solution

  • Turn on a necessary feature gate in all_tuples example.
  • Add annotation in debugging.md

Testing

The result of following cmd is almost the same as docs.rs

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --example all_tuples --no-deps --open

@BenjaminBrienen
Copy link
Collaborator

GitHub needs to add a button to retrigger CI

@BenjaminBrienen BenjaminBrienen merged commit 847a953 into bevyengine:main Nov 24, 2025
66 of 70 checks passed
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.

2 participants