-
-
Notifications
You must be signed in to change notification settings - Fork 438
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
Installation guide: Show system package commands using sphinx-inline-tabs #37056
Conversation
… package commands
…abs for HTTPS/SSH
…o system package section
6914f61
to
cfe1e6b
Compare
cfe1e6b
to
2fe88d0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks very good to me.
As you are here, may I ask if you know the reason why sage docs failed to be published on recent beta releases? |
Documentation preview for this PR (built with commit 2392b19; changes) is ready! 🎉 |
Thanks for the review! |
Did they? https://deploy-livedoc--sagemath.netlify.app/html/en/reference/index.html is current as of 10.3.beta6 |
(I updated the links in https://github.com/sagemath/sage/wiki today) |
Ah, just wrong link. Thanks! |
…ing sphinx-inline-tabs <!-- ^^^^^ 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 --> Preview: https://deploy-preview-37056-- sagemath.netlify.app/html/en/installation/source#linux-system-package- installation Same for the SPKG pages in the reference manual. https://deploy- preview-37056-- sagemath.netlify.app/html/en/reference/spkg/gfortran#equivalent-system- packages Same for the git instructions in the developer guide, using 2 tabs for HTTPS and SSH: https://deploy-preview-37056-- sagemath.netlify.app/html/en/developer/github#forking-the-sage- repository <!-- 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. - [ ] 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: ... --> - Depends on sagemath#36957 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37056 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
…ing sphinx-inline-tabs <!-- ^^^^^ 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 --> Preview: https://deploy-preview-37056-- sagemath.netlify.app/html/en/installation/source#linux-system-package- installation Same for the SPKG pages in the reference manual. https://deploy- preview-37056-- sagemath.netlify.app/html/en/reference/spkg/gfortran#equivalent-system- packages Same for the git instructions in the developer guide, using 2 tabs for HTTPS and SSH: https://deploy-preview-37056-- sagemath.netlify.app/html/en/developer/github#forking-the-sage- repository <!-- 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. - [ ] 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: ... --> - Depends on sagemath#36957 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37056 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
…ing sphinx-inline-tabs <!-- ^^^^^ 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 --> Preview: https://deploy-preview-37056-- sagemath.netlify.app/html/en/installation/source#linux-system-package- installation Same for the SPKG pages in the reference manual. https://deploy- preview-37056-- sagemath.netlify.app/html/en/reference/spkg/gfortran#equivalent-system- packages Same for the git instructions in the developer guide, using 2 tabs for HTTPS and SSH: https://deploy-preview-37056-- sagemath.netlify.app/html/en/developer/github#forking-the-sage- repository <!-- 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. - [ ] 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: ... --> - Depends on sagemath#36957 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37056 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
…nline tabs <!-- ^^^^^ 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 --> Every doctest block is decorated with tabs, by default showing the original doctest in **Sage** syntax, and offering a preparsed, pure **Python** version of it. The tabs are synchronized across the page. If @kwankyu's live documentation is being built, it is offered as another tab **Sage (live)**. When this tab is selected, it automatically starts the Thebe/Binder; it is not necessary to find and push the "Make live" button. ![tabs-anim](https://github.com/sagemath/sage/assets/8345221/4252ae92- eeb7-417a-ba24-c141726f714d) [Preview](https://deploy-preview-37083--sagemath.netlify.app/html/en/ref erence/function_fields/sage/rings/function_field/function_field_rational ) <!-- 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". --> Fixes sagemath#35791 <!-- 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: ... --> - Depends on sagemath#37056 - Depends on sagemath#37065 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37083 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe, Tobias Diez
Preview: https://deploy-preview-37056--sagemath.netlify.app/html/en/installation/source#linux-system-package-installation
Same for the SPKG pages in the reference manual. https://deploy-preview-37056--sagemath.netlify.app/html/en/reference/spkg/gfortran#equivalent-system-packages
Same for the git instructions in the developer guide, using 2 tabs for HTTPS and SSH: https://deploy-preview-37056--sagemath.netlify.app/html/en/developer/github#forking-the-sage-repository
📝 Checklist
⌛ Dependencies