2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-22 11:03:06 +00:00
bevy/tools/build-templated-pages/Cargo.toml
Giacomo Stevanato 71c5f1e3e4
Generate links to definition in source code pages on docs.rs and dev-docs.bevyengine.org ()
# Objective

- Fix issue 

## 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 , 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

18 lines
449 B
TOML

[package]
name = "build-templated-pages"
edition = "2021"
description = "Tool that checks and fixes undocumented features and examples"
publish = false
license = "MIT OR Apache-2.0"
[dependencies]
toml_edit = { version = "0.22.7", default-features = false, features = [
"parse",
] }
tera = "1.15"
serde = { version = "1.0", features = ["derive"] }
bitflags = "2.3"
hashbrown = { version = "0.14", features = ["serde"] }
[lints]
workspace = true