Skip to content
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.

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

Docs: explains flyout position #11954

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Docs: explains flyout position #11954

merged 3 commits into from
Jan 29, 2025

Conversation

humitos
Copy link
Member

@humitos humitos commented Jan 27, 2025

  • Small explanation of how to set the flyout position from the webui
  • Note for theme authors on how to explicitly define it from their themes

Closes readthedocs/addons#498


📚 Documentation previews 📚

- Small explanation of how to set the flyout position from the webui
- Note for theme authors on how to explicitly define it from their themes

Closes readthedocs/addons#498
@humitos humitos requested a review from a team as a code owner January 27, 2025 09:49
@humitos humitos requested a review from ericholscher January 27, 2025 09:49
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Looks good, but I think we at least want to explain inline, or link to where it is defined?

docs/user/flyout-menu.rst Outdated Show resolved Hide resolved
<readthedocs-flyout position="bottom-left"></readthedocs-flyout>


Available positions: ``bottom-left``, ``bottom-right``, ``top-left``, ``top-right``, ``inline``.
Copy link
Member

Choose a reason for hiding this comment

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

We don't explain what inline is in this PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

I just removed the mention to inline because I'm not 100% sure how it should behave yet -- so, I don't want to explain something that I'm not sure if it's correct.

We can come back here once we finish and merge readthedocs/addons#500

docs/user/flyout-menu.rst Outdated Show resolved Hide resolved
@humitos humitos merged commit 03f73a6 into main Jan 29, 2025
8 checks passed
@humitos humitos deleted the humitos/flyout-position-docs branch January 29, 2025 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document new flyout location options
2 participants