bevy/tools/example-showcase
Giacomo Stevanato 71c5f1e3e4
Generate links to definition in source code pages on docs.rs and dev-docs.bevyengine.org (#12965)
# Objective

- Fix issue #2611

## Solution

- Add `--generate-link-to-definition` to all the `rustdoc-args` arrays
in the `Cargo.toml`s (for docs.rs)
- Add `--generate-link-to-definition` to the `RUSTDOCFLAGS` environment
variable in the docs workflow (for dev-docs.bevyengine.org)
- Document all the workspace crates in the docs workflow (needed because
otherwise only the source code of the `bevy` package will be included,
making the argument useless)
- I think this also fixes #3662, since it fixes the bug on
dev-docs.bevyengine.org, while on docs.rs it has been fixed for a while
on their side.

---

## Changelog

- The source code viewer on docs.rs now includes links to the
definitions.
2024-07-29 23:10:16 +00:00
..
src allow more configuration for showcase from the CLI (#13217) 2024-07-22 18:29:47 +00:00
asset-source-website.patch Fix asset-source-website.patch line number (#13286) 2024-05-12 20:49:43 +00:00
Cargo.toml Generate links to definition in source code pages on docs.rs and dev-docs.bevyengine.org (#12965) 2024-07-29 23:10:16 +00:00
disable-audio.patch run examples on macOS to validate PRs (#11630) 2024-01-31 20:03:47 +00:00
extra-window-resized-events.patch fix: upgrade to winit v0.30 (#13366) 2024-06-03 13:06:48 +00:00
fixed-window-position.patch hacks for running (and screenshotting) the examples in CI on a github runner (#9220) 2023-10-13 19:19:17 +00:00
reduce-light-cluster-config.patch Regenerate light cluster patch file (#13655) 2024-06-03 18:19:32 +00:00
remove-desktop-app-mode.patch fix: upgrade to winit v0.30 (#13366) 2024-06-03 13:06:48 +00:00
window-settings-wasm.patch Fix example showcase wasm window settings patch (#12608) 2024-04-06 22:07:49 +00:00