bevy/.github
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
..
actions/install-linux-deps Create custom action for installing Linux dependencies (#12850) 2024-04-13 22:34:48 +00:00
contributing Fixed #14248 and other URL issues (#14276) 2024-07-11 12:01:49 +00:00
example-run Test for ambiguous system ordering in CI (#13950) 2024-07-17 21:05:48 +00:00
ISSUE_TEMPLATE Add a performance regression issue template (#8279) 2023-04-04 01:04:18 +00:00
linters meta: Add Showcase section to PR template (#11750) 2024-07-08 01:23:24 +00:00
start-mobile-example Remove unused variable (#10966) 2023-12-13 20:41:45 +00:00
start-wasm-example Rename functions and variables to follow code style (#10961) 2023-12-13 20:20:24 +00:00
workflows 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
dependabot.yml dependabot: use new C-Dependencies label 2021-07-13 12:51:48 -07:00
FUNDING.yml Update funding link (#12425) 2024-03-11 21:46:04 +00:00
pull_request_template.md meta: Add Showcase section to PR template (#11750) 2024-07-08 01:23:24 +00:00