-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Rewrite installation instructions #3930
base: main
Are you sure you want to change the base?
Rewrite installation instructions #3930
Conversation
I wonder whether we should collapse the installation instructions for Windows / MacOS / Linux back onto one single page and make use of code tabs https://sphinx-design.readthedocs.io/en/furo-theme/tabs.html#tabbed-code-examples to switch out the respective instructions? With all the externally managed Python environments around it might also be worth considering just recommending an installation via uv; |
Just took a look and it looks amazing! Definitely agree with using tabs for different operating systems.
The idea of just
And then most IDE's will recognize that a Or we could just not use uv :) |
I just pushed a commit changing the recommendation to |
I very much like what you have done here, thank you for your efforts! After some more thinking, there are some details I would change (I can push a commit -- or a separate branch for a 1:1 comparison):
But all in all, I definitely agree that this sort of unified set of instructions is the way to go. We should look into setting up redirects from the old /windows, /linux, /macos pages to the new /local (or /pip?) page, otherwise we will break a lot of static guides. |
Feel free to push a commit, I probably won't be able to work on this PR until next weekend. |
#3501 removed the ffmpeg dependency - this meant that our installation docs could be drastically simplified. This an attempt to do that. Specifically
Leaves Optional Dependency stuff in their own file depending on the system.EDIT: They're now in tabs - see behackl's commentFurther improvement ideas welcome!
Also closes #3864
https://manimce--3930.org.readthedocs.build/en/3930/installation/local.html