Skip to content

Switch between different versions of documentations #609

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.

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

Closed
seisman opened this issue Sep 17, 2020 · 3 comments · Fixed by #621
Closed

Switch between different versions of documentations #609

seisman opened this issue Sep 17, 2020 · 3 comments · Fixed by #621
Labels
documentation Improvements or additions to documentation feature request New feature wanted

Comments

@seisman
Copy link
Member

seisman commented Sep 17, 2020

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 GenericMappingTools/gmt#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

@seisman seisman added documentation Improvements or additions to documentation feature request New feature wanted labels Sep 17, 2020
@weiji14
Copy link
Member

weiji14 commented Sep 17, 2020

Probably easiest to follow the PR at GenericMappingTools/gmt#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
Copy link
Member Author

seisman commented Sep 17, 2020

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
Copy link
Member

weiji14 commented Sep 17, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature request New feature wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants