Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-22 12:43:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

fail when an example doesn't set doc-scrape-examples (#12964)

Browse source 
# Objective

- Ensure that all examples are scrapped for doc

## Solution

- Panic in the example tool when an example doesn't specify
`doc-scrape-examples`
- If an example must not be scrapped, it can set the value to false
This commit is contained in:
François Mockers 2024-04-14 22:07:55 +02:00 committed by GitHub
parent 0256dacba4
commit 62f2a73cac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
tools/build-templated-pages/src/examples.rs
View file

@ -58,6 +58,9 @@ fn parse_examples(panic_on_missing: bool) -> Vec<Example> {
if panic_on_missing && metadatas.get(&technical_name).is_none() { if panic_on_missing && metadatas.get(&technical_name).is_none() {
panic!("Missing metadata for example {technical_name}"); panic!("Missing metadata for example {technical_name}");
} }
if panic_on_missing && val.get("doc-scrape-examples").is_none() {
panic!("Example {technical_name} is missing doc-scrape-examples");
}
if metadatas if metadatas
.get(&technical_name) .get(&technical_name)