Fix Help menu breakdown in external jupyterlab case #38005
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kwankyu
changed the title
kwankyu
changed the title
kwankyu
force-pushed
the
documentation-for-external-jupyterlab
branch
from
1e02202
to
def978a
Compare
|
I cannot test this PR because my sage is broken... |
|
Documentation preview for this PR (built with commit def978a; changes) is ready! 🎉 |
|
Can't test it either, but LGTM. |
|
Thanks! |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 18, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> sagemath#37878 introduced a local documentation server for jupyterlab. But it missed a case for which the Help menu of jupyterlab may break down. In the setup explained in https://doc.sagemath.org/html/en/installation/launching.html#setting-up- sagemath-as-a-jupyter-kernel-in-an-existing-jupyter-notebook-or- jupyterlab-installation, external jupyterlab is launched and connected to sage kernel. In this case, the local doc server does not run, but the Help menu of the jupyterlab still expects a local doc server, and thus the Help menu does not work well. In this PR, local doc server is detected by testing the port number, and the Help menu uses the online official documentation if local doc server is not running. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38005 Reported by: Kwankyu Lee Reviewer(s):
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 18, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> sagemath#37878 introduced a local documentation server for jupyterlab. But it missed a case for which the Help menu of jupyterlab may break down. In the setup explained in https://doc.sagemath.org/html/en/installation/launching.html#setting-up- sagemath-as-a-jupyter-kernel-in-an-existing-jupyter-notebook-or- jupyterlab-installation, external jupyterlab is launched and connected to sage kernel. In this case, the local doc server does not run, but the Help menu of the jupyterlab still expects a local doc server, and thus the Help menu does not work well. In this PR, local doc server is detected by testing the port number, and the Help menu uses the online official documentation if local doc server is not running. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38005 Reported by: Kwankyu Lee Reviewer(s):
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#37878 introduced a local documentation server for jupyterlab. But it missed a case for which the Help menu of jupyterlab may break down.
In the setup explained in https://doc.sagemath.org/html/en/installation/launching.html#setting-up-sagemath-as-a-jupyter-kernel-in-an-existing-jupyter-notebook-or-jupyterlab-installation, external jupyterlab is launched and connected to sage kernel. In this case, the local doc server does not run, but the Help menu of the jupyterlab still expects a local doc server, and thus the Help menu does not work well.
In this PR, local doc server is detected by testing the port number, and the Help menu uses the online official documentation if local doc server is not running.
📝 Checklist
⌛ Dependencies