search

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
758 stars 220 forks source link

Switch between different versions of documentations #609

Closed seisman closed 4 years ago

seisman commented 4 years ago

Description of the desired feature

We have versioned documentation for each PyGMT release. All the versions are listed in the PyGMT main site. image

GMT's PR https://github.com/GenericMappingTools/gmt/pull/4110 enables switching between different versions. You can try the switcher in the GMT's documentation site.

To me, it would be great if the same feature can be implemented in the PyGMT site.

Are you willing to help implement and maintain this feature? Yes

weiji14 commented 4 years ago

Probably easiest to follow the PR at https://github.com/GenericMappingTools/gmt/pull/4110. I wonder though how other projects put it on the bottom bar. See e.g. xarray at http://xarray.pydata.org/en/stable/:

image

seisman commented 4 years ago

I wonder though how other projects put it on the bottom bar. See e.g. xarray at http://xarray.pydata.org/en/stable/:

ReadTheDocs automatically shows all versions if the project documentation is hosted on their server.

weiji14 commented 4 years ago

Ah ok, but we don't use ReadTheDocs. Then just use the version_switch.js file then.