manim icon indicating copy to clipboard operation
manim copied to clipboard

Add conda installation docs

Open pavelzw opened this issue 2 years ago • 1 comments

Overview: What does this pull request change?

  • Add conda installation documentation
  • fix spelling of "macOS"
  • Add "Working with Manim" section in Linux installation page

Motivation and Explanation: Why and how do your changes improve the library?

Once manim is released to conda-forge, we need to add installation instructions.

Closes #2862.

Links to added or changed documentation pages

https://manimce--2914.org.readthedocs.build/en/2914/installation.html https://manimce--2914.org.readthedocs.build/en/2914/installation/conda.html

Very minor changes: https://manimce--2914.org.readthedocs.build/en/2914/contributing/development.html https://manimce--2914.org.readthedocs.build/en/2914/index.html https://manimce--2914.org.readthedocs.build/en/2914/installation/linux.html https://manimce--2914.org.readthedocs.build/en/2914/installation/macos.html

Further Information and Comments

CC @naveen521kk

Still to do:

  • [ ] make Windows build available
  • [ ] make osx-arm64 build available
  • [ ] make linux-aarch64 build available

Reviewer Checklist

  • [ ] The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • [ ] If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • [ ] If applicable: newly added functions and classes are tested

pavelzw avatar Aug 06 '22 11:08 pavelzw

Edit: fixed

Does anybody know how to link to labels on different sites in sphinx?

The CI logs print out this:

/home/docs/checkouts/readthedocs.org/user_builds/manimce/checkouts/2914/docs/source/installation/conda.rst:32: WARNING: undefined label: '/installation/windows:win-optional-dependencies'
/home/docs/checkouts/readthedocs.org/user_builds/manimce/checkouts/2914/docs/source/installation/conda.rst:32: WARNING: undefined label: '/installation/linux:linux-optional-dependencies'
/home/docs/checkouts/readthedocs.org/user_builds/manimce/checkouts/2914/docs/source/installation/conda.rst:32: WARNING: undefined label: '/installation/macos:macos-optional-dependencies'

pavelzw avatar Aug 06 '22 15:08 pavelzw

conda install -c conda-forge manim now finally works with oxs-arm64 and linux-aarch64. 🥳 Since manim is now available on all relevant platforms through conda-forge, this PR is ready for review.

@naveen521kk can you/somebody else please review this?

pavelzw avatar Aug 31 '22 12:08 pavelzw