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.

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

Version switcher not working for old docs #932

Closed
datapythonista opened this issue Sep 20, 2022 · 7 comments
Closed

Version switcher not working for old docs #932

datapythonista opened this issue Sep 20, 2022 · 7 comments
Labels
kind: bug Something isn't working needs: more information Needs more information from the author before we can move forward

Comments

@datapythonista
Copy link
Member

In your own website, if you're in an old version of the docs, the links in the version switcher are incorrect. Change version from example from here: https://pydata-sphinx-theme.readthedocs.io/en/v0.8.0/index.html

We had a similar problem with pandas, for context see this comment: pandas-dev/pandas#48600 (comment)

@drammock drammock added this to the 0.10.2 milestone Sep 20, 2022
@drammock drammock added the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Sep 20, 2022
@jarrodmillman jarrodmillman modified the milestones: 0.10.2, 0.11 Sep 20, 2022
@jarrodmillman jarrodmillman mentioned this issue Sep 20, 2022
18 tasks
@choldgraf
Copy link
Collaborator

choldgraf commented Sep 25, 2022

It looks like in our documentation this problem begins with 0.8 and is fine >= 0.8.1:

It seems like on 0.8.0 it's adding an extra v to the URL (so the URL incorrectly renders as https://pydata-sphinx-theme.readthedocs.io/en/vv0.8.1/

For your theme, could you backport an update to your documentation so that the pydata theme is updated and thus the switcher configuration behaves properly?

I don't think there is anything that we can do about this for the pydata theme, because we can't backport a higher version of our own theme to the documentation of the same theme. IMO our solution should be to remove documentation for versions older than ~0.8.1

@drammock could you provide a rationale for why you think this issue should block any future releases?

@datapythonista
Copy link
Member Author

For us it broke in the release we started using url instead of version, so we kept the versions broken in the json, and the links are working well now. I think version is also used to compare the current version, and that may be broken, but not quite sure if there is anything not fully working.

@choldgraf
Copy link
Collaborator

My feeling is that we don't want to block all future releases on this issue, and we should remove the block-release label from this issue. I am not sure what exactly the problem is here, or what the fix should be, but it doesn't seem like it is a bug that has been introduced since the last release, and so I'm not sure what benefit we get from blocking a new release.

@drammock drammock removed the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Sep 28, 2022
@drammock
Copy link
Collaborator

My feeling is that we don't want to block all future releases on this issue

agreed. I've removed the tag. I initially added it somewhat hastily without looking closely enough at what the problem was. I'd like to leave this open though as a reminder to consider backporting a fix... IMO there is a valid use case for switching back and forth between current and older doc versions (namely, figuring out when a change was introduced if it's not in the changelog), which requires that the switcher work correctly on the older sites.

@choldgraf
Copy link
Collaborator

Definitely agree we should track this one - though I'm still not sure yet what the underlying fix needs to be.

@jarrodmillman jarrodmillman modified the milestones: 0.11, 0.12 Oct 4, 2022
sc336 added a commit to GPflow/GPflow that referenced this issue Nov 7, 2022
…me#932) doesn't look like it's getting fixed any time soon, pinning to earlier version
sc336 added a commit to GPflow/GPflow that referenced this issue Nov 7, 2022
…me#932) doesn't look like it's getting fixed any time soon, pinning to earlier version
sc336 added a commit to GPflow/GPflow that referenced this issue Nov 8, 2022
…me#932) doesn't look like it's getting fixed any time soon, pinning to earlier version
sc336 added a commit to GPflow/GPflow that referenced this issue Nov 11, 2022
…me#932) doesn't look like it's getting fixed any time soon, pinning to earlier version
sc336 added a commit to GPflow/GPflow that referenced this issue Nov 14, 2022
…me#932) doesn't look like it's getting fixed any time soon, pinning to earlier version (#2014)
@12rambau 12rambau modified the milestones: 0.12, 0.13 Nov 17, 2022
@choldgraf choldgraf removed this from the 0.13 milestone Jan 11, 2023
@12rambau
Copy link
Collaborator

12rambau commented Aug 1, 2023

@datapythonista, we actually dropped the version 0.8 from our version switcher so this is no longer a bug for us. did you find a workaround from your side or is it still an active issue ?

@12rambau 12rambau added kind: bug Something isn't working needs: more information Needs more information from the author before we can move forward labels Aug 1, 2023
@trallard
Copy link
Collaborator

trallard commented Jul 1, 2024

Thank you for your issue!

We haven't gotten a response to our questions in our comment #932 (comment). With only the current information on the issue, we don't have enough information to take action. I'm going to close this, but don't hesitate to reach out if you have or find the answers we need. We'll be happy to reopen the issue.

@trallard trallard closed this as completed Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: bug Something isn't working needs: more information Needs more information from the author before we can move forward
Projects
None yet
Development

No branches or pull requests

6 participants