Add documentation for packaging SageMath downstream #40162
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a dedicated guide for downstream packagers of SageMath, refactors the existing packaging docs title, and integrates the new file into the developer index.
- Rename the “Packaging the Sage Library for Distribution” chapter to “Modularized Distribution”
- Update the
developer/index.rstto include a newdownstreamentry - Introduce
downstream.rstwith detailed steps for building and packaging SageMath
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/doc/en/developer/packaging_sage_library.rst | Adjusted chapter title for packaging guide |
| src/doc/en/developer/index.rst | Added downstream to the packaging toctree |
| src/doc/en/developer/downstream.rst | New downstream packaging documentation |
Comments suppressed due to low confidence (1)
src/doc/en/developer/downstream.rst:28
- Replace the accent mark around PURLs with a proper backtick to form an inline code literal:
PURLs.
The `external` section follows `PEP 725 <https://peps.python.org/pep-0725/>`_ and specifies dependencies in the form of ̀PURLs.
| @@ -2,7 +2,7 @@ | |||
| .. _chapter-modularization: | |||
|
|
|||
| =========================================== | |||
| Packaging the Sage Library for Distribution | |||
| Modularized Distribution | |||
There was a problem hiding this comment.
[nitpick] The new chapter title “Modularized Distribution” may be too generic; consider a more descriptive title like “Packaging the Sage Library for Distribution” to clarify its purpose.
Suggested change
| Modularized Distribution | |
| Packaging the Sage Library for Distribution |
Copilot uses AI. Check for mistakes.
tobiasdiez
requested review from
dimpase,
orlitzky,
tornaria,
isuruf and
antonio-rojas
antonio-rojas
approved these changes
May 26, 2025
|
Thanks! |
dimpase
approved these changes
May 26, 2025
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 28, 2025
sagemathgh-40162: Add documentation for packaging SageMath downstream <!-- ^ 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". --> Using meson. Should hopefully make it easier for downstream maintainers to get started, so that we might get sage back in Fedora/Ubuntu/... I don't have any packaging experience myself, so please make suggestions! ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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#40162 Reported by: Tobias Diez Reviewer(s): Antonio Rojas, Copilot, Dima Pasechnik, Tobias Diez
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.
Using meson. Should hopefully make it easier for downstream maintainers to get started, so that we might get sage back in Fedora/Ubuntu/...
I don't have any packaging experience myself, so please make suggestions!
📝 Checklist
⌛ Dependencies