Skip to content

Remove screenshots from online docs export. #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PoignardAzur merged 3 commits into from
May 8, 2025
Merged

Remove screenshots from online docs export. #952

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62dec35
Remove screenshots from online docs export.
PoignardAzur May 8, 2025
22daea1
Disable other macro, add some doc.
PoignardAzur May 8, 2025
6fea3ce
Fix build
PoignardAzur May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions masonry_core/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
19 changes: 18 additions & 1 deletion masonry_core/src/testing/screenshots.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

use image::{GenericImageView as _, Pixel as _, Rgb, RgbImage};

#[cfg(docsrs)]
// TODO - Re-enable this once we find a way to load screenshots that doesn't go against our
// storage quotas.
#[cfg(FALSE)]
Copy link
Copy Markdown
Member

@DJMcNab DJMcNab May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rust-lang/rust#138632

cfg(false) should be stable in 6 weeks!

#[doc(hidden)]
#[macro_export]
macro_rules! include_screenshot {
Expand All @@ -19,6 +21,21 @@ macro_rules! include_screenshot {
};
}

#[cfg(docsrs)]
Comment thread
xStrom marked this conversation as resolved.
Outdated
#[doc(hidden)]
#[macro_export]
macro_rules! include_screenshot {
($path:literal $(, $caption:literal)? $(,)?) => {
// On docsrs we just remove the screenshot links for now.
" "
};
}

// 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

#[cfg(FALSE)]
#[cfg(not(docsrs))]
#[doc(hidden)]
#[macro_export]
Expand Down
Loading