Fix: Hide flyout in print/PDF output#652
Open
CodeManEthan wants to merge 1 commit intoreadthedocs:mainfrom
Open
Fix: Hide flyout in print/PDF output#652CodeManEthan wants to merge 1 commit intoreadthedocs:mainfrom
CodeManEthan wants to merge 1 commit intoreadthedocs:mainfrom
Conversation
Add @media print rule to flyout Shadow DOM CSS to prevent the version selector from appearing in printed documentation or PDF exports. The flyout overlaps content when printing, making documentation hard to read. This fix uses @media print with :host selector to hide the entire Shadow DOM component during print.
agjohnson
reviewed
Dec 3, 2025
Contributor
agjohnson
left a comment
agjohnson
left a comment
There was a problem hiding this comment.
Good catch, thanks for the fix! I think we can keep the rule but skip !important precedence overriding, that should still work.
| /* Hide flyout when printing or generating PDFs */ | ||
| @media print { | ||
| :host { | ||
| display: none !important; |
Contributor
There was a problem hiding this comment.
!important shouldn't be needed here. We avoid !important, it's usually the source of precedence errors and it's hard to track down and resolve.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes the flyout menu overlapping documentation content when printing or generating PDFs.
Problem
The
<readthedocs-flyout>Shadow DOM component remains visible when printing documentation or saving as PDF, causing it to overlap and obscure the actual documentation content. This affects thousands of documentation sites hosted on Read the Docs.Solution
Added
@media printCSS rule inside the Shadow DOM styles (src/flyout.css) to hide the flyout element when printing:Why This Approach
:hostselector which correctly targets the Shadow DOM rootTesting
Screenshots
Before:
After:
