Skip to content
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

Replace ad-hoc package installation instructions by links to SPKG page #37532

Open
mkoeppe opened this issue Mar 3, 2024 · 5 comments
Open

Replace ad-hoc package installation instructions by links to SPKG page #37532

mkoeppe opened this issue Mar 3, 2024 · 5 comments
Assignees
@Demon-Sheriff @siddharthbaleja7
Labels
c: documentation good first issue

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Mar 3, 2024

From #37315 (comment)

  • what is the way to install optional packages given that

    • sage -i is not an option for system sage (= not built from source)

Instead of pointing people to sage -i, point them to the SPKG page in the Sage Reference Manual, which has the install instructions for all systems that carry the package. For example:
https://deploy-preview-37315--sagemath.netlify.app/html/en/reference/spkg/qepcad#equivalent-system-packages

Within the Sage library, you can write :ref:`qepcad <spkg_qepcad>`

@siddharthbaleja7
Copy link

@mkoeppe please assign this issue to me.

@Demon-Sheriff
Copy link
Contributor

hey @mkoeppe , if this issue is still open , I would like to work on it.

@Demon-Sheriff
Copy link
Contributor

@mkoeppe This link : https://deploy-preview-37315--sagemath.netlify.app/html/en/reference/spkg/qepcad#equivalent-system-packages does not seem to be working

Screenshot from 2024-08-08 15-35-01

Demon-Sheriff added a commit to Demon-Sheriff/sage that referenced this issue Aug 8, 2024
@Demon-Sheriff
Updated SPKG links for polymake as per sagemath#37532
0e9856e
@Demon-Sheriff Demon-Sheriff mentioned this issue Aug 8, 2024
Merged
5 tasks
@Demon-Sheriff
Copy link
Contributor

@mkoeppe I have raised a PR #38485 mentioning this issue, can you please check it.

@Demon-Sheriff
Copy link
Contributor

@vbraun Can you please review the PR #38485 for this issue.

vbraun pushed a commit to vbraun/sage that referenced this issue Aug 27, 2024
sagemathgh-38485: Updated SPKG links for polymake as per sagemath#37532
32f7576 
    
This PR updates the SPKG links for the `polymake` package in the
documentation. The goal is to provide users with direct links to the
Sage Reference Manual for installing optional packages, as suggested in
issue sagemath#37532.

**Changes Made:**
- Replaced ad-hoc package installation instructions with links to the
SPKG pages for packages like `4ti2`, `latte_int`, `topcom`, and `qhull`.
- Updated instructions to include links for additional software and the
`jupymake` package.
- Provided instructions for debugging installation problems.

**Why is this change required?**
This change aligns the documentation with the latest recommendations and
practices for installing optional packages in Sage, making it easier for
users to find and follow the correct installation instructions.

**Issue Reference:**
- Resolves issue
[sagemath#37532](https://github.com/YourRepo/YourProject/issues/37532).

### 📝 Checklist

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] 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#38485
Reported by: Anant Shukla
Reviewer(s):
vbraun pushed a commit to vbraun/sage that referenced this issue Aug 28, 2024
sagemathgh-38485: Updated SPKG links for polymake as per sagemath#37532
b3c8a32 
    
This PR updates the SPKG links for the `polymake` package in the
documentation. The goal is to provide users with direct links to the
Sage Reference Manual for installing optional packages, as suggested in
issue sagemath#37532.

**Changes Made:**
- Replaced ad-hoc package installation instructions with links to the
SPKG pages for packages like `4ti2`, `latte_int`, `topcom`, and `qhull`.
- Updated instructions to include links for additional software and the
`jupymake` package.
- Provided instructions for debugging installation problems.

**Why is this change required?**
This change aligns the documentation with the latest recommendations and
practices for installing optional packages in Sage, making it easier for
users to find and follow the correct installation instructions.

**Issue Reference:**
- Resolves issue
[sagemath#37532](https://github.com/YourRepo/YourProject/issues/37532).

### 📝 Checklist

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] 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#38485
Reported by: Anant Shukla
Reviewer(s):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Demon-Sheriff Demon-Sheriff

@siddharthbaleja7 siddharthbaleja7

Labels
c: documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mkoeppe @Demon-Sheriff @siddharthbaleja7