Skip to content

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Feb 15, 2023

📚 Description

Fixes #34794

📝 Checklist

  • I have made sure that the title is self-explanatory and the description concisely explains the PR.
  • I have linked an issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@codecov-commenter
Copy link

codecov-commenter commented Feb 15, 2023

Codecov Report

Patch coverage: 77.77% and project coverage change: -0.01 ⚠️

Comparison is base (f449b14) 88.62% compared to head (05362d5) 88.61%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #35139      +/-   ##
===========================================
- Coverage    88.62%   88.61%   -0.01%     
===========================================
  Files         2148     2148              
  Lines       398653   398659       +6     
===========================================
- Hits        353308   353276      -32     
- Misses       45345    45383      +38     
Impacted Files Coverage Δ
src/sage/repl/ipython_kernel/kernel.py 88.23% <71.42%> (-5.10%) ⬇️
src/sage/env.py 88.10% <100.00%> (+0.10%) ⬆️

... and 27 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@kwankyu kwankyu closed this Mar 18, 2023
@kwankyu kwankyu deleted the fix/34794/run-doc-server-along-with-jupyter branch March 18, 2023 06:52
@kwankyu kwankyu restored the fix/34794/run-doc-server-along-with-jupyter branch March 18, 2023 06:54
@kwankyu kwankyu reopened this Mar 18, 2023
@github-actions
Copy link

Documentation preview for this PR is ready! 🎉
Built with commit: 05362d5

@kwankyu kwankyu closed this Dec 13, 2023
@kwankyu kwankyu deleted the fix/34794/run-doc-server-along-with-jupyter branch December 13, 2023 11:56
@kwankyu kwankyu mentioned this pull request Apr 27, 2024
5 tasks
vbraun pushed a commit to vbraun/sage that referenced this pull request May 12, 2024
sagemathgh-37878: Run sage doc server for jupyterlab 
    
<!-- ^ 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". -->

Reopen sagemath#35139 because of the renewed interest:
https://groups.google.com/g/sage-devel/c/kzSWB8ps7VA

New environment variables added to `sage.env`:
```
SAGE_DOC_SERVER_URL = var("SAGE_DOC_SERVER_URL")
SAGE_DOC_LOCAL_PORT = var("SAGE_DOC_LOCAL_PORT", "0")
```
When Jupyter notebook launches,
- If `SAGE_DOC_SERVER_URL` is set, the url is used;
- else if local sage documentation is installed, a doc http server with
port `SAGE_DOC_LOCAL_PORT` starts. If the port is 0 (the default), then
a random port is selected by the system and stored to the environment
variable;
- else the online official documentation website
https://doc.sagemath.org is used

for the help menu of the Jupyter notebook.

Fixes sagemath#34794.

### 📝 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.
- [ ] 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#37878
Reported by: Kwankyu Lee
Reviewer(s): Kwankyu Lee, Marc Culler
vbraun pushed a commit to vbraun/sage that referenced this pull request May 12, 2024
sagemathgh-37878: Run sage doc server for jupyterlab 
    
<!-- ^ 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". -->

Reopen sagemath#35139 because of the renewed interest:
https://groups.google.com/g/sage-devel/c/kzSWB8ps7VA

New environment variables added to `sage.env`:
```
SAGE_DOC_SERVER_URL = var("SAGE_DOC_SERVER_URL")
SAGE_DOC_LOCAL_PORT = var("SAGE_DOC_LOCAL_PORT", "0")
```
When Jupyter notebook launches,
- If `SAGE_DOC_SERVER_URL` is set, the url is used;
- else if local sage documentation is installed, a doc http server with
port `SAGE_DOC_LOCAL_PORT` starts. If the port is 0 (the default), then
a random port is selected by the system and stored to the environment
variable;
- else the online official documentation website
https://doc.sagemath.org is used

for the help menu of the Jupyter notebook.

Fixes sagemath#34794.

### 📝 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.
- [ ] 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#37878
Reported by: Kwankyu Lee
Reviewer(s): Kwankyu Lee, Marc Culler
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.

Run doc server along with jupyter server
3 participants