fixing docs with scraping examples enabled

[mockersf]

Objective

• disable scraping examples in doc #22142 didn't work as intended as scrapping examples is enabled by default on docs.rs

Solution

• Disable only the examples that causes scraping to ICE

[ChristopherBiscardi]

I ran this locally (macos) and saw ice. Is there a different version or way I should be running this?

cargo 1.94.0-nightly (e91b2baa6 2025-12-13)

cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --all-features --workspace --no-deps --document-private-items --exclude ci --exclude errors --exclude bevy_mobile_example --exclude build-wasm-example --exclude build-templated-pages --exclude example-showcase

ice

thread 'rustc' panicked at src/librustdoc/html/sources.rs:349:14:
only local crates should have sources emitted
stack backtrace:
   0:        0x11235a8bc - <std[b7feb89905cd93eb]::backtrace::Backtrace>::create
   1:        0x11023d6bc - std[b7feb89905cd93eb]::panicking::update_hook::<alloc[bdc2e4ad6d4bf0c0]::boxed::Box<rustc_driver_impl[518898bfa7fddfdd]::install_ice_hook::{closure#1}>>::{closure#0}
   2:        0x11236b900 - std[b7feb89905cd93eb]::panicking::panic_with_hook
   3:        0x112350014 - std[b7feb89905cd93eb]::panicking::panic_handler::{closure#0}
   4:        0x112346e60 - std[b7feb89905cd93eb]::sys::backtrace::__rust_end_short_backtrace::<std[b7feb89905cd93eb]::panicking::panic_handler::{closure#0}, !>
   5:        0x11235162c - __rustc[c5cdacb199e14793]::rust_begin_unwind
   6:        0x1150c5058 - core[ac3ce927dba65c0a]::panicking::panic_fmt
   7:        0x1150c4d5c - core[ac3ce927dba65c0a]::option::expect_failed
   8:        0x10338bcec - <&core[ac3ce927dba65c0a]::fmt::builders::FromFn<rustdoc[5d2e2dfe6e3e5176]::html::sources::print_src<&mut core[ac3ce927dba65c0a]::fmt::Formatter>::{closure#0}> as core[ac3ce927dba65c0a]::fmt::Display>::fmt
   9:        0x10f628610 - core[ac3ce927dba65c0a]::fmt::write
  10:        0x10338c0dc - <&askama[348d40915f53d0d4]::filters::escape::Safe<&core[ac3ce927dba65c0a]::fmt::builders::FromFn<rustdoc[5d2e2dfe6e3e5176]::html::sources::print_src<&mut core[ac3ce927dba65c0a]::fmt::Formatter>::{closure#0}>> as core[ac3ce927dba65c0a]::fmt::Display>::fmt
  11:        0x10f628610 - core[ac3ce927dba65c0a]::fmt::write
  12:        0x1031f2944 - rustdoc[5d2e2dfe6e3e5176]::html::render::render_call_locations::<&mut core[ac3ce927dba65c0a]::fmt::Formatter>::{closure#2}
  13:        0x1033b88d4 - <core[ac3ce927dba65c0a]::fmt::builders::FromFn<rustdoc[5d2e2dfe6e3e5176]::html::render::document_full_inner::{closure#0}> as core[ac3ce927dba65c0a]::fmt::Display>::fmt
  14:        0x1030c1458 - rustdoc[5d2e2dfe6e3e5176]::html::render::render_impl::{closure#0}::doc_impl_item::<&mut alloc[bdc2e4ad6d4bf0c0]::string::String, &mut alloc[bdc2e4ad6d4bf0c0]::string::String>
  15:        0x1033b6b38 - <core[ac3ce927dba65c0a]::fmt::builders::FromFn<rustdoc[5d2e2dfe6e3e5176]::html::render::render_impl::{closure#0}> as core[ac3ce927dba65c0a]::fmt::Display>::fmt
  16:        0x103360298 - <core[ac3ce927dba65c0a]::iter::adapters::map::Map<core[ac3ce927dba65c0a]::iter::adapters::filter_map::FilterMap<indexmap[e25be4814154c27]::map::iter::Values<rustdoc[5d2e2dfe6e3e5176]::clean::types::ItemId, rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::AliasedTypeImpl>, <rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::Part<rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::TypeAlias, rustdoc[5d2e2dfe6e3e5176]::html::render::ordered_json::OrderedJson>>::get::{closure#0}>, <rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::Part<rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::TypeAlias, rustdoc[5d2e2dfe6e3e5176]::html::render::ordered_json::OrderedJson>>::get::{closure#1}> as core[ac3ce927dba65c0a]::iter::traits::iterator::Iterator>::next
  17:        0x1033200ac - rustdoc[5d2e2dfe6e3e5176]::html::render::write_shared::write_shared
  18:        0x103263d58 - <rustdoc[5d2e2dfe6e3e5176]::html::render::context::Context>::init
  19:        0x1031f804c - rustdoc[5d2e2dfe6e3e5176]::main_args::{closure#2}::{closure#0}
  20:        0x1031eed38 - rustc_interface[1c63beac88df496d]::interface::run_compiler::<(), rustdoc[5d2e2dfe6e3e5176]::main_args::{closure#2}>::{closure#1}
  21:        0x103155af8 - std[b7feb89905cd93eb]::sys::backtrace::__rust_begin_short_backtrace::<rustc_interface[1c63beac88df496d]::util::run_in_thread_with_globals<rustc_interface[1c63beac88df496d]::util::run_in_thread_pool_with_globals<rustc_interface[1c63beac88df496d]::interface::run_compiler<(), rustdoc[5d2e2dfe6e3e5176]::main_args::{closure#2}>::{closure#1}, ()>::{closure#0}, ()>::{closure#0}::{closure#0}, ()>
  22:        0x10321cbe0 - <std[b7feb89905cd93eb]::thread::lifecycle::spawn_unchecked<rustc_interface[1c63beac88df496d]::util::run_in_thread_with_globals<rustc_interface[1c63beac88df496d]::util::run_in_thread_pool_with_globals<rustc_interface[1c63beac88df496d]::interface::run_compiler<(), rustdoc[5d2e2dfe6e3e5176]::main_args::{closure#2}>::{closure#1}, ()>::{closure#0}, ()>::{closure#0}::{closure#0}, ()>::{closure#1} as core[ac3ce927dba65c0a]::ops::function::FnOnce<()>>::call_once::{shim:vtable#0}
  23:        0x1123760fc - <std[b7feb89905cd93eb]::sys::thread::unix::Thread>::new::thread_start
  24:        0x183fe4c08 - __pthread_cond_wait


rustc version: 1.94.0-nightly (f794a0873 2025-12-17)
platform: aarch64-apple-darwin

query stack during panic:
end of query stack

[alice-i-cecile]

😔 This is the least bad path forward for right now.

[mockersf]

I ran this locally (macos) and saw ice. Is there a different version or way I should be running this?

I used cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --no-deps for the example selection, adding --all-features adds more ICE 😞

[mockersf]

I think I got them all this time

[ChristopherBiscardi]

Still seeing ice on 4b21da6

ice details

thread 'rustc' panicked at src/librustdoc/html/sources.rs:349:14:
only local crates should have sources emitted
stack backtrace:
   0:        0x1143afcb4 - <std[6c644d12a05cc840]::backtrace::Backtrace>::create
   1:        0x11228f5bc - std[6c644d12a05cc840]::panicking::update_hook::<alloc[d103dd452be8af5e]::boxed::Box<rustc_driver_impl[923a066edf67befc]::install_ice_hook::{closure#1}>>::{closure#0}
   2:        0x1143c0cf8 - std[6c644d12a05cc840]::panicking::panic_with_hook
   3:        0x1143a540c - std[6c644d12a05cc840]::panicking::panic_handler::{closure#0}
   4:        0x11439a150 - std[6c644d12a05cc840]::sys::backtrace::__rust_end_short_backtrace::<std[6c644d12a05cc840]::panicking::panic_handler::{closure#0}, !>
   5:        0x1143a6a24 - __rustc[f25f47d7eb20112d]::rust_begin_unwind
   6:        0x11711a454 - core[c38b1bd981b9c911]::panicking::panic_fmt
   7:        0x11711a158 - core[c38b1bd981b9c911]::option::expect_failed
   8:        0x1052c3bcc - <&core[c38b1bd981b9c911]::fmt::builders::FromFn<rustdoc[163200ae7bb709f6]::html::sources::print_src<&mut core[c38b1bd981b9c911]::fmt::Formatter>::{closure#0}> as core[c38b1bd981b9c911]::fmt::Display>::fmt
   9:        0x1116778ac - core[c38b1bd981b9c911]::fmt::write
  10:        0x1052c3fbc - <&askama[344f17d33750b2d9]::filters::escape::Safe<&core[c38b1bd981b9c911]::fmt::builders::FromFn<rustdoc[163200ae7bb709f6]::html::sources::print_src<&mut core[c38b1bd981b9c911]::fmt::Formatter>::{closure#0}>> as core[c38b1bd981b9c911]::fmt::Display>::fmt
  11:        0x1116778ac - core[c38b1bd981b9c911]::fmt::write
  12:        0x10512a8d4 - rustdoc[163200ae7bb709f6]::html::render::render_call_locations::<&mut core[c38b1bd981b9c911]::fmt::Formatter>::{closure#2}
  13:        0x1052f0918 - <core[c38b1bd981b9c911]::fmt::builders::FromFn<rustdoc[163200ae7bb709f6]::html::render::document_full_inner::{closure#0}> as core[c38b1bd981b9c911]::fmt::Display>::fmt
  14:        0x104ff93c8 - rustdoc[163200ae7bb709f6]::html::render::render_impl::{closure#0}::doc_impl_item::<&mut alloc[d103dd452be8af5e]::string::String, &mut alloc[d103dd452be8af5e]::string::String>
  15:        0x1052eeae0 - <core[c38b1bd981b9c911]::fmt::builders::FromFn<rustdoc[163200ae7bb709f6]::html::render::render_impl::{closure#0}> as core[c38b1bd981b9c911]::fmt::Display>::fmt
  16:        0x105298088 - <core[c38b1bd981b9c911]::iter::adapters::map::Map<core[c38b1bd981b9c911]::iter::adapters::filter_map::FilterMap<indexmap[5bd530fc4195175]::map::iter::Values<rustdoc[163200ae7bb709f6]::clean::types::ItemId, rustdoc[163200ae7bb709f6]::html::render::write_shared::AliasedTypeImpl>, <rustdoc[163200ae7bb709f6]::html::render::write_shared::Part<rustdoc[163200ae7bb709f6]::html::render::write_shared::TypeAlias, rustdoc[163200ae7bb709f6]::html::render::ordered_json::OrderedJson>>::get::{closure#0}>, <rustdoc[163200ae7bb709f6]::html::render::write_shared::Part<rustdoc[163200ae7bb709f6]::html::render::write_shared::TypeAlias, rustdoc[163200ae7bb709f6]::html::render::ordered_json::OrderedJson>>::get::{closure#1}> as core[c38b1bd981b9c911]::iter::traits::iterator::Iterator>::next
  17:        0x105257e9c - rustdoc[163200ae7bb709f6]::html::render::write_shared::write_shared
  18:        0x10519bcc0 - <rustdoc[163200ae7bb709f6]::html::render::context::Context>::init
  19:        0x10512fff4 - rustdoc[163200ae7bb709f6]::main_args::{closure#2}::{closure#0}
  20:        0x1051276c8 - rustc_interface[749b1839e19e006a]::interface::run_compiler::<(), rustdoc[163200ae7bb709f6]::main_args::{closure#2}>::{closure#1}
  21:        0x105092258 - std[6c644d12a05cc840]::sys::backtrace::__rust_begin_short_backtrace::<rustc_interface[749b1839e19e006a]::util::run_in_thread_with_globals<rustc_interface[749b1839e19e006a]::util::run_in_thread_pool_with_globals<rustc_interface[749b1839e19e006a]::interface::run_compiler<(), rustdoc[163200ae7bb709f6]::main_args::{closure#2}>::{closure#1}, ()>::{closure#0}, ()>::{closure#0}::{closure#0}, ()>
  22:        0x105154b48 - <std[6c644d12a05cc840]::thread::lifecycle::spawn_unchecked<rustc_interface[749b1839e19e006a]::util::run_in_thread_with_globals<rustc_interface[749b1839e19e006a]::util::run_in_thread_pool_with_globals<rustc_interface[749b1839e19e006a]::interface::run_compiler<(), rustdoc[163200ae7bb709f6]::main_args::{closure#2}>::{closure#1}, ()>::{closure#0}, ()>::{closure#0}::{closure#0}, ()>::{closure#1} as core[c38b1bd981b9c911]::ops::function::FnOnce<()>>::call_once::{shim:vtable#0}
  23:        0x1143cb4f4 - <std[6c644d12a05cc840]::sys::thread::unix::Thread>::new::thread_start
  24:        0x183fe4c08 - __pthread_cond_wait


rustc version: 1.94.0-nightly (fcf67da03 2025-12-18)
platform: aarch64-apple-darwin

query stack during panic:
end of query stack

[mockersf]

Could you try on a linux and without --workspace? to be closer to docs.rs

[ChristopherBiscardi]

Running the more limited command here results in vulkan import issues in wgpu_hal on macos.

cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --no-deps --all-features

I unfortunately don't have a linux install ready to test

[DaAlbrecht]

on my Linux machine using: cargo 1.94.0-nightly (2c283a9a5 2025-12-04)

The command:

cargo doc \
    -Zunstable-options \
    -Zrustdoc-scrape-examples \
    --all-features \
    --workspace \
    --no-deps \
    --document-private-items \
    --exclude ci \
    --exclude errors \
    --exclude bevy_mobile_example \
    --exclude build-wasm-example \
    --exclude build-templated-pages \
    --exclude example-showcase

Builds the docs without ICE's.