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.

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

Jump to bottom

Clarify flyout options #11750

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Clarify flyout options #11750

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76864f8
Clarify flyout options
plaindocs Nov 7, 2024
8d634de
Merge branch 'main' into sam/doctools-update
humitos Nov 11, 2024
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
24 changes: 6 additions & 18 deletions docs/user/intro/sphinx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,28 +100,16 @@ If you're using a different theme, enable :doc:`Server side search </server-side
"readthedocs.js",
]

Integrate the Read the Docs version menu into your site navigation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. TODO: adapt and uncomment this section.
We've changed `flyout_display` to be `hidden` by default;
If people want to use the integrated version of it, they should declare it as `attached`.
However, as we have the version/language selectors now,
we want to promote that more and keep the Addons flyout enabled by default.
The :ref:`flyout-menu:Addons flyout menu` displays differently depending to which Sphinx theme your documentation uses.

Integrate the Read the Docs version menu into your site navigation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- If you're using the `Read the Docs Sphinx Theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`__, the :ref:`flyout-menu:Addons flyout menu` is already fully integrated into the theme. Use the theme options `flyout_display <https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-flyout_display>`__, `version_selector <https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-version_selector>`__, `language_selector <https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-language_selector>`__ to configure it.

If you're using the `Read the Docs Sphinx Theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`__, the :ref:`flyout-menu:Addons flyout menu` is already fully integrated.
- If you're using another theme, the flyout menu displays in the bottom right of the docs.

You *may* need to set `flyout_display` to `hidden <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#confval-flyout_display>`_ in your ``conf.py`` so as not to display two identical menus:

.. code-block:: py
:caption: conf.py

html_theme_options = {
"flyout_display": "hidden",
}

If you're using a different theme, the flyout menu will display in the default bottom right side of your docs.
In either case, you can configure the flyout menu sorting and display options in :guilabel:`Settings`, under :guilabel:`Addons`.

Using Markdown with Sphinx
--------------------------
Expand Down
Loading