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

Use URLs to online Sage documents for JupyterLab #36246

Merged
merged 4 commits into from
Oct 31, 2023

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Sep 11, 2023

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

  • The title is concise, informative, and self-explanatory.
  • 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

@kwankyu kwankyu changed the title Use urls to external documents for JupyterLab Use URLs to online Sage documents for JupyterLab Sep 11, 2023
@kwankyu kwankyu marked this pull request as ready for review September 17, 2023 01:29
@mkoeppe mkoeppe requested a review from egourgoulhon October 25, 2023 21:52
Copy link
Member

@egourgoulhon egourgoulhon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I've checked that Sage documentation is now available from the Jupyerlab menu.

@egourgoulhon
Copy link
Member

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.

@egourgoulhon
Copy link
Member

Thank you for the fix!

@mkoeppe mkoeppe added this to the sage-10.2 milestone Oct 29, 2023
@kwankyu
Copy link
Collaborator Author

kwankyu commented Oct 29, 2023

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.

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

jupyter/notebook#6963

which will be fixed in the upcoming notebook 7.1. So we will see this later.

Thanks for the review!

@github-actions
Copy link

Documentation preview for this PR (built with commit 39a53cc; changes) is ready! 🎉

vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 29, 2023
    
<!-- ^^^^^
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
@vbraun vbraun merged commit b42b381 into sagemath:develop Oct 31, 2023
16 of 19 checks passed
@kwankyu kwankyu deleted the p/use-external-urls-in-jupyterlab branch December 13, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants