-
-
Notifications
You must be signed in to change notification settings - Fork 654
Run sage doc server along with jupyter notebooks #35139
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
Run sage doc server along with jupyter notebooks #35139
Conversation
Codecov ReportPatch coverage:
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
... 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. |
Documentation preview for this PR is ready! 🎉 |
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
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
📚 Description
Fixes #34794
📝 Checklist
⌛ Dependencies