diff --git a/masonry_core/ARCHITECTURE.md b/masonry_core/ARCHITECTURE.md index a1b6b5a9c1..07b7c64b01 100644 --- a/masonry_core/ARCHITECTURE.md +++ b/masonry_core/ARCHITECTURE.md @@ -154,6 +154,10 @@ The screenshots are stored using git LFS, which adds some minor complications bu We include some of the screenshots in the documentation; because `docs.rs` doesn't have access to LFS files, we use the `include_screenshot!` to instead link to `https://media.githubusercontent.com` when building doc for `docs.rs`. +**Note:** The above may or may not be true at the time you read this document. +We've had problems with the `docsrs` flag and Github's handling of LFS files. +See also https://github.com/linebender/xilem/issues/851. + ## VS Code markers Masonry uses VS Code markers to help users browse code with the minimap: diff --git a/masonry_core/src/testing/screenshots.rs b/masonry_core/src/testing/screenshots.rs index 336588f359..c89d5a6608 100644 --- a/masonry_core/src/testing/screenshots.rs +++ b/masonry_core/src/testing/screenshots.rs @@ -5,6 +5,22 @@ use image::{GenericImageView as _, Pixel as _, Rgb, RgbImage}; +// FIXME - We're essentially completely disabling screenshots, period. +// Hopefully we'll be able to re-enable them soon. +// See https://github.com/linebender/xilem/issues/851 + +#[doc(hidden)] +#[macro_export] +macro_rules! include_screenshot { + ($path:literal $(, $caption:literal)? $(,)?) => { + // On docsrs we just remove the screenshot links for now. + " " + }; +} + +// TODO - Re-enable this once we find a way to load screenshots that doesn't go against our +// storage quotas. +#[cfg(FALSE)] #[cfg(docsrs)] #[doc(hidden)] #[macro_export] @@ -19,6 +35,7 @@ macro_rules! include_screenshot { }; } +#[cfg(FALSE)] #[cfg(not(docsrs))] #[doc(hidden)] #[macro_export]