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.

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

DOC: update installation page #811

Closed
lucascolley opened this issue Dec 23, 2024 · 22 comments
Closed

DOC: update installation page #811

lucascolley opened this issue Dec 23, 2024 · 22 comments

Comments

@lucascolley
Copy link

We just overhauled the SciPy installation page at https://scipy.org/install/, including:

  • creating a separate beginner guide for those who may not be comfortable with using a terminal or happy to learn to use a package manager
  • recommending project-based workflows to users who do not consider themselves beginners (uv and pixi)
  • modernising instructions for installing with pip or conda

You may wish to do similar things for https://numpy.org/install/. Feel free to copy anything I wrote on the SciPy page!

@mattip
Copy link
Member

mattip commented Dec 24, 2024

It might be nice to set this up as a tab-based page with a tab for each installation method. This would emphasize that they are equivalent alternatives.

@Musharraffaijaz
Copy link
Contributor

Hi,
@lucascolley @mattip I'm working on a PR that would involve making some lengthier commits to the installation instructions in the install.md file.
If thats fine, I'd be happy to create the PR for your review.

Thanks,

@Musharraffaijaz
Copy link
Contributor

@mattip what about this? Since in markdowns, there is no option for Tabs and we can get tabs in MDX instead, so instead of a tab based navigation, how about the tabular one?

Image

@mattip
Copy link
Member

mattip commented Jan 29, 2025

If you want you could try something like this for tabs. I think the tabular (table) view wastes too much valuable space.

@Musharraffaijaz
Copy link
Contributor

The PR updated the installation page with tab based navigation #608 resolves this issues

@lucascolley
Copy link
Author

Hi @Musharraffaijaz - it looks like your PR affects scipy.org. This issue was about potential updates to numpy.org.

I'll have a look at your PR to see whether it looks like an improvement for SciPy! But I don't think it would close this issue.

@jarrodmillman
Copy link
Member

Here is how you use tabs with the theme: https://theme.scientific-python.org/user_guide/web-components/#tabs

@jarrodmillman
Copy link
Member

Here's more information: https://theme.scientific-python.org/shortcodes/#tabs

@Musharraffaijaz
Copy link
Contributor

Musharraffaijaz commented Jan 30, 2025

We just overhauled the SciPy installation page at https://scipy.org/install/, including:

  • creating a separate beginner guide for those who may not be comfortable with using a terminal or happy to learn to use a package manager
  • recommending project-based workflows to users who do not consider themselves beginners (uv and pixi)
  • modernising instructions for installing with pip or conda

You may wish to do similar things for https://numpy.org/install/. Feel free to copy anything I wrote on the SciPy page!

@lucascolley I have used the same tabs approach which Mattip suggested, and what I understood from the issue is that there are 5 installation methods for scipy, which I tried to separate using these tabs. The tabs are I had used are similiar to what @jarrodmillman has suggested, but scipy

Image

@Musharraffaijaz
Copy link
Contributor

@lucascolley @mattip what could be the improvements to the https://numpy.org/install/ page? I mean do we have to try the similiar tab-based navigation as we did in the scipy/install page?

@mattip
Copy link
Member

mattip commented Feb 5, 2025

It would be nice to refactor the NumPy pages to be much like the SciPy page after that PR lands.

@Musharraffaijaz
Copy link
Contributor

Musharraffaijaz commented Feb 5, 2025

It would be nice to refactor the NumPy pages to be much like the SciPy page after that PR lands.

@mattip Thank you for the reply, I will begin working on the task immediately. While that PR has been approved, I would greatly appreciate it if you could conduct a final review to facilitate its merge. Once that is complete, I will commence work on the NumPy integration.

@Musharraffaijaz
Copy link
Contributor

Musharraffaijaz commented Feb 6, 2025

@mattip @lucascolley @jarrodmillman @stefanv, wanted to know, how to approach here https://numpy.org/install

Image
A Tab for (PIP and Conda), then after recommendations a tab for (Beginners and Advanced), then the similiar for Python package management (Pip, conda & Reproducible installs)?
Is this the intended format/flow?

@mattip
Copy link
Member

mattip commented Feb 6, 2025

I'm not sure, but I think I prefer the layout 1:1 from the https://scipy.org/install/ page instead of what we have. What do others think?

@melissawm
Copy link
Member

I agree, the scipy page looks awesome and the contents should be very similar so I'd vote to follow that.

@Musharraffaijaz
Copy link
Contributor

@mattip @melissawm thank you for your review, could you please check the PR "Update the numpy installation page with tab based navigation" which tries to update the Numpy installation page.

@Musharraffaijaz
Copy link
Contributor

@lucascolley @mattip could you please review this PR #832

@melissawm
Copy link
Member

melissawm commented Feb 14, 2025

Hi @Musharraffaijaz - sorry for the delay, it looks like we are all a bit busy but we'll make sure to come back to this issue when we can. Thanks for the patience!

@Musharraffaijaz
Copy link
Contributor

@melissawm sure, sorry for any inconvenience caused.

@Musharraffaijaz
Copy link
Contributor

I guess this issue is now resolved, @mattip do you consider any other project or issue where I could contribute to?

@mattip
Copy link
Member

mattip commented Feb 20, 2025

Thanks for fixing this. As for more issues, you could look at the ones in numpy and scipy that are marked "DOC".

@mattip mattip closed this as completed Feb 20, 2025
@Musharraffaijaz
Copy link
Contributor

Alright, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants