Use URLs to online Sage documents for JupyterLab #36246
Conversation
kwankyu
changed the title
egourgoulhon
left a comment
egourgoulhon
left a comment
There was a problem hiding this comment.
LGTM. I've checked that Sage documentation is now available from the Jupyerlab menu.
|
A side comment: this PR changes the access to Sage documentation for the Jupyter notebook as well (not only for Jupyterlab): the online documentation is now returned instead of the local one (this access was not broken in the Jupyter notebook, only in Jupyterlab). Some people may consider this as a kind of regression (one should privilege the locally build doc over the online one), but only a very minor one, IMHO. So I think this is OK. |
|
Thank you for the fix! |
Right. I was aware of that. I agree with you about the regression. By the way, for Jupyter notebook 7 that supersedes classic notebook, I guess that help links to local files might not work anyway just like with JupyterLab, since they say notebook 7 is sharing the core with JupyterLab. I could not confirm this because of the issue which will be fixed in the upcoming notebook 7.1. So we will see this later. Thanks for the review! |
|
Documentation preview for this PR (built with commit 39a53cc; changes) is ready! 🎉 |
sagemathgh-36246: Use URLs to online Sage documents for JupyterLab <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> Sage documents in the Help menu of JupyterLab have stopped working for long time. Those are essentially links to local files, but they don't work for JupyterLab. We replace them with URLs to online documents, to make them functional again. <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36246 Reported by: Kwankyu Lee Reviewer(s): Eric Gourgoulhon
4 participants
Sage documents in the Help menu of JupyterLab have stopped working for long time. Those are essentially links to local files, but they don't work for JupyterLab. We replace them with URLs to online documents, to make them functional again.
📝 Checklist
⌛ Dependencies