From eac0fd73b4ddbf7c29428378522fe5f4bc92a34e Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Mon, 27 Jan 2025 10:47:56 +0100 Subject: [PATCH 1/2] Docs: explains flyout position - 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 https://github.com/readthedocs/addons/issues/498 --- docs/user/flyout-menu.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/user/flyout-menu.rst b/docs/user/flyout-menu.rst index dc2b0d33e5b..8a9dce4e7da 100644 --- a/docs/user/flyout-menu.rst +++ b/docs/user/flyout-menu.rst @@ -52,6 +52,30 @@ You can sort by: You can also choose whether ``latest`` and ``stable`` should be sorted first, as those are special versions that Read the Docs uses. +Position +^^^^^^^^ + +The flyout position can be configured as: + +- :guilabel:`Default (from theme or Read the Docs)` - **Default**. If the theme author defines a specific position for the flyout, that position will be used. + Otherwise, the default position from Read the Docs will be used: ``Bottom right``. +- :guilabel:`Bottom left` - Show the flyout at the bottom left. +- :guilabel:`Bottom right` - Show the flyout at the bottom right. +- :guilabel:`Top left` - Show the flyout at the top left. +- :guilabel:`Top right` - Show the flyout at the top right. + +.. note:: + + If you are a theme author and want to define a default flyout position for your theme, + you can explicitly define the flyout web component with the ``position`` attribute in your HTML: + + .. code:: html + + + + + Available positions: ``bottom-left``, ``bottom-right``, ``top-left``, ``top-right``, ``inline``. + Custom event integration ------------------------ From 41b38e0c20254ccbb2994b9e1be9b753a849ce74 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Tue, 28 Jan 2025 10:49:25 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/flyout-menu.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/flyout-menu.rst b/docs/user/flyout-menu.rst index 8a9dce4e7da..127bf2654c6 100644 --- a/docs/user/flyout-menu.rst +++ b/docs/user/flyout-menu.rst @@ -55,7 +55,7 @@ as those are special versions that Read the Docs uses. Position ^^^^^^^^ -The flyout position can be configured as: +The flyout can be configured in the :term:`dashboard` with the following positions: - :guilabel:`Default (from theme or Read the Docs)` - **Default**. If the theme author defines a specific position for the flyout, that position will be used. Otherwise, the default position from Read the Docs will be used: ``Bottom right``. @@ -74,7 +74,7 @@ The flyout position can be configured as: - Available positions: ``bottom-left``, ``bottom-right``, ``top-left``, ``top-right``, ``inline``. + Available positions: ``bottom-left``, ``bottom-right``, ``top-left`` and ``top-right``. Custom event integration ------------------------