MDAnalysis / mdanalysis

MDAnalysis is a Python library to analyze molecular dynamics simulations.
https://mdanalysis.org
Other
1.26k stars 641 forks source link

Keep the page when switching versions in documentation #4629

Open yuxuanzhuang opened 3 days ago

yuxuanzhuang commented 3 days ago

Is your feature request related to a problem?

I often encounter landing on the old version of documentation when searching through Google.

For example, if I search for mdanalysis rmsd in Google, the first result leads to version 1.1.1 (https://docs.mdanalysis.org/1.1.1/documentation_pages/analysis/rms.html).

When I try to switch to a different version with the default version selector, it can only take me to the main page (https://docs.mdanalysis.org/stable/) and not the specific documentation I need. It’s very frustrating.

Describe the solution you'd like

There's an addon in readthedocs called Flyout that can now keep the page when switching version/language

yuxuanzhuang commented 3 days ago

Refer to the comments below to enable this functionality:

https://github.com/astropy/astropy/issues/15114#issuecomment-1731777150

It works pretty well

https://mdanalysis-beta.readthedocs.io/en/stable/documentation_pages/selections.html