Skip to content

Docs: add recommendation to use meson/conda in building from source #40845

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

Docs: add recommendation to use meson/conda in building from source #40845

wants to merge 9 commits into from

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Sep 18, 2025 •
edited
Loading

To make it clearer that the meson build is the preferred option (if one is willing to use conda, or uses an OS with sufficiently recent versions of the deps).

For the same reason, sources.rst is renamed to sources-distro and the old meson is now sources.

Triggered by https://groups.google.com/g/sage-devel/c/4WgRmMQ3UVE

📝 Checklist

  • 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

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 18, 2025 •
edited
Loading

Documentation preview for this PR (built with commit eb1d7be; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@dimpase
Copy link
Member

dimpase commented Sep 23, 2025

Can you explain whether it's mostly a refactoring the existing docs, or you wrote a lot from scratch?

@tobiasdiez
Copy link
Contributor Author

I've added a reference from sage-the-distro build to meson build (https://github.com/sagemath/sage/pull/40845/files#diff-aaad790db70e5c2814a04f89e1ff42d568006c0de023ba4662b1c81e0c0f021aR8-R13). Otherwise there were no substantial changes in neither the meson nor sage distro docs - this is just a rename (which is sadly not handled well by git). There were a few minor edits to the installation/index page but they are nicely visible from the git changelog.

@dimpase
Copy link
Member

dimpase commented Sep 28, 2025

Not for this PR, but the text says

By default, SageMath installs itself as a Jupyter kernel in the same environment as the SageMath installation.

but this is not (always) so - cause --user argument would tell an external jupyter to install the kernel into ~/ rather than into the environment. As jupyter/jupyter_client#1070 told us a lot about the correct ways to handle this, it's good to have a go at it so that it gets included in 10.8 release.

@dimpase
Copy link
Member

dimpase commented Sep 28, 2025

"gmpy2 ~=2.1.b999" in uv instructions is outdated.
We now ship 2.2.1

@dimpase
Copy link
Member

dimpase commented Sep 28, 2025 •
edited
Loading

Using Jupyter notebook through Visual Studio Code (VS Code) in WSL is too Windows-centric.
Roughly the same can be done on Linux (or macOS)

This was referenced Sep 28, 2025
Open
Open
@tobiasdiez
Copy link
Contributor Author

Thanks, these are good remarks! I've opened new issues for them, as they are a bit unrelated to the PR (I didn't touch the relevant sections here). Also the gmpy update actually touches CI/devcontainer, and the WSL launching section is touched by #40893 so it's better to revise this after the next beta.

dimpase
dimpase approved these changes Sep 28, 2025
View reviewed changes
Copy link
Member

@dimpase dimpase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 29, 2025
8ad7ab5 
sagemathgh-40845: Docs: add recommendation to use meson/conda in building from source
    
<!-- ^ 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". -->

To make it clearer that the meson build is the preferred option (if one
is willing to use conda, or uses an OS with sufficiently recent versions
of the deps).

For the same reason, `sources.rst` is renamed to `sources-distro` and
the old `meson` is now `sources`.

Triggered by https://groups.google.com/g/sage-devel/c/4WgRmMQ3UVE

### 📝 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#40845
Reported by: Tobias Diez
Reviewer(s): Dima Pasechnik
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 30, 2025
dcc9f10 
sagemathgh-40845: Docs: add recommendation to use meson/conda in building from source
    
<!-- ^ 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". -->

To make it clearer that the meson build is the preferred option (if one
is willing to use conda, or uses an OS with sufficiently recent versions
of the deps).

For the same reason, `sources.rst` is renamed to `sources-distro` and
the old `meson` is now `sources`.

Triggered by https://groups.google.com/g/sage-devel/c/4WgRmMQ3UVE

### 📝 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#40845
Reported by: Tobias Diez
Reviewer(s): Dima Pasechnik
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vbraun vbraun Awaiting requested review from vbraun

1 more reviewer

@dimpase dimpase dimpase approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
s: positive review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tobiasdiez @dimpase