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

Rewrite installation instructions #3930

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Sep 2, 2024

#3501 removed the ffmpeg dependency - this meant that our installation docs could be drastically simplified. This an attempt to do that. Specifically

  • Merges macOS and Windows installation instructions into one
  • Leaves Optional Dependency stuff in their own file depending on the system. EDIT: They're now in tabs - see behackl's comment

Further improvement ideas welcome!

Also closes #3864

https://manimce--3930.org.readthedocs.build/en/3930/installation/local.html

@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Sep 2, 2024
@JasonGrace2282 JasonGrace2282 added this to the v0.19.0 milestone Sep 2, 2024
@behackl
Copy link
Member

behackl commented Oct 20, 2024

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; uv tool install manim. This would, however, probably increase friction as users would then look up the path to the tool env and feed that into their IDEs ... 🤔

@JasonGrace2282
Copy link
Member Author

JasonGrace2282 commented Oct 20, 2024

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?

Just took a look and it looks amazing! Definitely agree with using tabs for different operating systems.

With all the externally managed Python environments around it might also be worth considering just recommending an installation via uv; uv tool install manim. This would, however, probably increase friction as users would then look up the path to the tool env and feed that into their IDEs ... 🤔

The idea of just uvx manim and calling it a day does seem pretty cool, but I agree users might have trouble linking the uv tool environment to their IDE. I think a better approach might be to just tell users to do something like

# I wonder what python will be chosen if the user doesn't have python
uv init project-name
cd project-name
uv add manim
uv run manim -p ...

And then most IDE's will recognize that a .venv folder exists in the current directory. Not as clean as a simple uv tool install manim, but it avoids that pain point.

Or we could just not use uv :)

@JasonGrace2282
Copy link
Member Author

I just pushed a commit changing the recommendation to uv, would be glad to hear thoughts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

Improvement on the python-dev version
2 participants