Ipywidgets: Redirect ReadTheDocs default URL to the stable version

Created on 5 Jul 2017  路  13Comments  路  Source: jupyter-widgets/ipywidgets

The documentation for this used to be really helpful and quick to understand when it was hosted on readthedocs. Now it seems to have been changed to (or changes made to) http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20List.html the widgets no longer render.

Most helpful comment

Yes, if you go to https://ipywidgets.readthedocs.io/, it redirects to the latest docs. The default should be set to point to stable.

All 13 comments

Thanks. Please use the latest stable docs to see the rendered widgets: http://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html

To render widgets, we need to save the widget state to the document. This causes quite a bit of churn while we are in development, so we only save this state before releasing a beta or final version.

A slight oversite on my behalf - however all Google searches lead me to http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20List.html and not stable. I am not sure why this was the case.

image

This might be useful to know if more people cannot find the stable docs. Anyway, thanks for the explanation and the link :)

Yes, if you go to https://ipywidgets.readthedocs.io/, it redirects to the latest docs. The default should be set to point to stable.

Yes. I get this also. Maybe I will re-open this.

I've modified the title to indicate what needs to be done.

@SylvainCorlay - can you redirect the default readthedocs URL to the stable version?

@SylvainCorlay - can you do this before the tutorial?

Done now, with @willingc's help! http://ipywidgets.readthedocs.io redirects to the stable version documentation.

(I don't know what we can do about the /latest docs showing up in the google search first, but hopefully the default pointing to stable will over time make the google rank the stable results higher).

Unfortunately, I have noticed this with other docs as well. Count be a wider issue!

Unfortunately, I have noticed this with other docs as well. Count be a wider issue!

I think it's the ReadTheDocs default to point to the master documentation. Would you mind posting to the Jupyter mailing list about this? You're right that it might be something we consider at a project-wide level.

Thanks again!

@jasongrout posted here. Hopefully this is what you were looking for.

Was this page helpful?
0 / 5 - 0 ratings