Skip to content

Hide unbuilt versions in the flyout #6971

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
ericholscher opened this issue Apr 27, 2020 · 4 comments · Fixed by #7056
Closed

Hide unbuilt versions in the flyout #6971

ericholscher opened this issue Apr 27, 2020 · 4 comments · Fixed by #7056
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors

Comments

@ericholscher
Copy link
Member

Currently we show links to docs in the flyout that have built=False in them. This leads to 404's. We should filter those out when showing the version list when we expect users to be able to view the docs.

@ericholscher ericholscher added Accepted Accepted issue on our roadmap Good First Issue Good for new contributors labels Apr 27, 2020
@prashantmital
Copy link

prashantmital commented Sep 30, 2020

Is there a way to disable this behavior? On https://pymongo.readthedocs.io/en/stable/ we relied on unbuilt versions showing up in the version picker. The 404s were worked around using a redirect to another website that hosted docs for those versions.

For example, https://pymongo.readthedocs.io/en/3.5.0/ shows the documentation that we want. But 3.5.0 does not show up in our version picker because the corresponding RTD build has failed.

@stsewd
Copy link
Member

stsewd commented Sep 30, 2020

No, you can't disable this behavior, I'm not sure if we want to support that use case (showing fake versions). Maybe a better solution would be showing those versions in another page.

@prashantmital
Copy link

@stsewd thanks for the quick response. I'm surprised to learn that you have no plans to support this use-case especially since it seems like you are aware of it: #6137 (comment)

@humitos
Copy link
Member

humitos commented Oct 1, 2020

@prashantmital Yeah. I'd like to reconsider this use case eventually and build a proper feature around it (instead of the "hidden feature" that I described in the linked comment). I know some people were using this already.

I'd suggest you to open a new issue as "Feature request" explaining your use case and linking the history around this. I don't think it will hit our roadmap soon though, but I'd like to see this feature to happen eventually. This is a good onboarding feature for people migrating their docs into Read the Docs, which is 💯 to us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants