search

readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.81k stars 1.74k forks source link

Split flyout integration into different selectors #1587

Open humitos opened 3 months ago

humitos commented 3 months ago

We've been talking about splitting the integration of the flyout into different selectors/blocks and place them outside the flyout. In fact, the concept of the flyout may not apply anymore for Sphinx theme after moving this information outside the current flyout -- leaving the concept of flyout only to the one injected by Read the Docs addons.

Using CPython as an example, the version and language selectors could be placed at the top left, below the project's logo/name:

Screenshot_2024-08-09_16-12-54

Besides, the "On Read the Docs" section from the original flyout could be moved to the footer:

Screenshot_2024-08-09_16-13-09

These are just examples, but I think it reflects how theme authors will integrate with us in a better way without the following the flyout concept.

Related: https://github.com/readthedocs/addons/issues/51

humitos commented 1 month ago

The selectors were already implemented in https://github.com/readthedocs/sphinx_rtd_theme/pull/1601. The only missing part is mentioning "Hosted on Read the Docs". I opened a PR for this at #1616

humitos commented 3 weeks ago

OK. I'm moving this issue out from the current roadmap, since it's not a huge priority and there is more work than I expected here.