search

scipy / scipy-sphinx-theme-v2

New version of scipy-sphinx-theme to be used across NumPy documentaton page and subpages.
https://pr-72-scipy-sphinx-theme-v2.surge.sh/
3 stars 5 forks source link

doc - historical & PDF version tab in navbar #29

Closed Shekharrajak closed 5 years ago

Shekharrajak commented 5 years ago

References to other Issues or PRs

Brief description of what is fixed or changed

Testcase / documentation

Other comments

Deployed URL

https://pr-29-scipy-sphinx-theme-v2.surge.sh

Shekharrajak commented 5 years ago

So this new tab will redirect to numpy/doc which have list of history and previous versions. PR in numpy/doc: https://github.com/numpy/doc/pull/1

rgommers commented 5 years ago

So this is the "Historical & PDF version" link in the right top corner:

image

The principle of linking to that page is right. I'm not sure that pdf is worth mentioning there. Perhaps "Other doc versions"?

What would also be nice is to have a small banner that's red and warns the user if they're not looking at the latest version. Because that's often an issue, and this top corner link doesn't make it clear that that's the case.

mattip commented 5 years ago

I thought the idea was to have a javascript-based version pull-down like at the top of the python documentation page, and changing the pulldown will redirect to that version of the documentation. Notification that this is not the devdoc version would also be good

Shekharrajak commented 5 years ago

The principle of linking to that page is right. I'm not sure that pdf is worth mentioning there. Perhaps "Other doc versions"?

Thanks for review. I will do this change.

What would also be nice is to have a small banner that's red and warns the user if they're not looking at the latest version. Because that's often an issue, and this top corner link doesn't make it clear that that's the case.

I was looking for that solution but didn't get any proper solution for it in sphinx. It looks like we need to add that 'old version' warning banner manually(may be during make command) when we create build and store it in numpy/doc repository.

I thought the idea was to have a javascript-based version pull-down like at the top of the python documentation page, and changing the pulldown will redirect to that version of the documentation. Notification that this is not the devdoc version would also be good

Yeah I thought about it but numpy.org/doc will serve the same purpose. May be we can add it as well and after clicking on specific version it will redirect to the same page with that selected version.

I will search for similar technique in sphinx.

mattip commented 5 years ago

I don't think sphinx does this. The scikit-image site doc site does something like what you started. @tylerjereddy started to [work on this] in numpy/numpy#12097 for numpy but got stuck on the template formatting.

Shekharrajak commented 5 years ago

Thanks @mattip for sharing the PR link. I will do research on it how can we do it in sphinx or using any sphinx module.

mattip commented 5 years ago

Bokeh has this https://docs.bokeh.org/en/dev/ via javascript and a json file