Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-25 14:10:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Sync flags in docs.yml with package.metadata.docs.rs (#14734)

Browse source 
# Objective

This PR is a follow-up to #14703. I forgot to also add the flags from
`package.metadata.docs.rs` to the docs build.

## Solution

As [discussed on
Discord](https://discord.com/channels/691052431525675048/1272629407659589663/1272643734260940940),
I added the missing flags to `docs.yml`.

I also updated `rustc-args` to properly make use of the array (I think
the value has to be either a space-separated string *or* an array of
strings but not an array of space-separated strings 😆)
This commit is contained in:
Tau Gärtli 2024-08-14 15:30:45 +02:00 committed by GitHub
parent 3d460e98ec
commit a34651502c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/docs.yml vendored
View file

@ -58,6 +58,7 @@ jobs:
- name: Build docs - name: Build docs
env: env:
# needs to be in sync with [package.metadata.docs.rs] # needs to be in sync with [package.metadata.docs.rs]
RUSTFLAGS: --cfg docsrs_dep
RUSTDOCFLAGS: -Zunstable-options --cfg=docsrs --generate-link-to-definition RUSTDOCFLAGS: -Zunstable-options --cfg=docsrs --generate-link-to-definition
run: | run: |
cargo doc \ cargo doc \

2
Cargo.toml
View file

@ -3368,7 +3368,7 @@ panic = "abort"
# impls for re-exported traits. See https://github.com/rust-lang/cargo/issues/8811 # impls for re-exported traits. See https://github.com/rust-lang/cargo/issues/8811
# for details on why this is needed. Since dependencies don't expect to be built # for details on why this is needed. Since dependencies don't expect to be built
# with `--cfg docsrs` (and thus fail to compile) we use a different cfg. # with `--cfg docsrs` (and thus fail to compile) we use a different cfg.
rustc-args = ["--cfg docsrs_dep"] rustc-args = ["--cfg", "docsrs_dep"]
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"] rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
all-features = true all-features = true
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"] cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]