mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
Update Docs Url (#832)
* Changed manimce links in the docs to docs.manim.community, replaced manimce with manim where applicable * black is extra finicky today Co-authored-by: Aron Fischer <cobordism@github, co-bordism@gitlab>
This commit is contained in:
parent
1318db5250
commit
247cdeecf6
4 changed files with 11 additions and 11 deletions
16
README.md
16
README.md
|
|
@ -2,12 +2,12 @@
|
|||
<a href="https://www.manim.community/"><img src="https://raw.githubusercontent.com/ManimCommunity/manim/master/logo/cropped.png"></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://pypi.org/project/manimce/"><img src="https://img.shields.io/pypi/v/manim.svg?style=flat" alt="PyPI Latest Release"></a>
|
||||
<a href="https://pypi.org/project/manim/"><img src="https://img.shields.io/pypi/v/manim.svg?style=flat" alt="PyPI Latest Release"></a>
|
||||
<a href="http://choosealicense.com/licenses/mit/"><img src="https://img.shields.io/badge/license-MIT-red.svg?style=flat" alt="MIT License"></a>
|
||||
<a href="https://www.reddit.com/r/manim/"><img src="https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=orange&label=reddit" alt="Reddit" href=></a>
|
||||
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
|
||||
<a href="https://discord.gg/mMRrZQW"><img src="https://img.shields.io/discord/581738731934056449.svg?label=discord&color=yellow" alt="Discord"></a>
|
||||
<a href="https://manimce.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/manimce/badge/?version=latest" alt="Documentation Status"></a>
|
||||
<a href="https://docs.manim.community/"><img src="https://readthedocs.org/projects/manimce/badge/?version=latest" alt="Documentation Status"></a>
|
||||
<a href="https://hub.docker.com/r/manimcommunity/manim"><img src="https://img.shields.io/docker/v/manimcommunity/manim?color=%23099cec&label=docker%20image" alt="Docker image"> </a>
|
||||
<a href="https://pepy.tech/project/manim"><img src="https://pepy.tech/badge/manim/month?" alt="Downloads"> </a>
|
||||
<img src="https://github.com/ManimCommunity/manim/workflows/CI/badge.svg" alt="CI">
|
||||
|
|
@ -32,7 +32,7 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
|
|||
|
||||
## Installation
|
||||
|
||||
Manim requires a few dependencies that must be installed prior to using it. Please visit the [documentation](https://manimce.readthedocs.io/en/latest/installation.html) and follow the appropriate instructions for your operating system.
|
||||
Manim requires a few dependencies that must be installed prior to using it. Please visit the [documentation](https://docs.manim.community/en/latest/installation.html) and follow the appropriate instructions for your operating system.
|
||||
|
||||
Once the dependencies have been installed, run the following in a terminal window:
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ manim example.py SquareToCircle -p -ql
|
|||
```
|
||||
|
||||
You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this
|
||||
[GitHub repository](master/example_scenes). You can also visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
|
||||
[GitHub repository](master/example_scenes). You can also visit the [official gallery](https://docs.manim.community/en/latest/examples.html) for more advanced examples.
|
||||
|
||||
## Command line arguments
|
||||
|
||||
|
|
@ -83,11 +83,11 @@ Some other useful flags include:
|
|||
- `-n <number>` to skip ahead to the `n`'th animation of a scene.
|
||||
- `-f` show the file in the file browser.
|
||||
|
||||
For a thorough list of command line arguments, visit the [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html).
|
||||
For a thorough list of command line arguments, visit the [documentation](https://docs.manim.community/en/latest/tutorials/configuration.html).
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
|
||||
Documentation is in progress at [ReadTheDocs](https://docs.manim.community/).
|
||||
|
||||
## Help with Manim
|
||||
|
||||
|
|
@ -96,9 +96,9 @@ Server](https://discord.gg/mMRrZQW) or [Reddit Community](https://www.reddit.com
|
|||
|
||||
## Contributing
|
||||
|
||||
Contributions to Manim are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://manimce.readthedocs.io/en/latest/contributing.html).
|
||||
Contributions to Manim are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://docs.manim.community/en/latest/contributing.html).
|
||||
|
||||
This project uses [Poetry](https://python-poetry.org/docs/) for management. You must have poetry installed and available in your environment. You can learn more `poetry` and how to use it at its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html).
|
||||
Most developers on the project use [Poetry](https://python-poetry.org/docs/) for management. You'll want to have poetry installed and available in your environment. You can learn more `poetry` and how to use it at its [Documentation](https://docs.manim.community/en/latest/installation/for_dev.html).
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -129,4 +129,4 @@ class UpdatersExample(Scene):
|
|||
self.wait()
|
||||
|
||||
|
||||
# See many more examples at https://manimce.readthedocs.io/en/latest/examples.html
|
||||
# See many more examples at https://docs.manim.community/en/latest/examples.html
|
||||
|
|
|
|||
|
|
@ -212,7 +212,7 @@ def convert_to_svg(dvi_file, extension, page=1):
|
|||
f"Your installation does not support converting {extension} files to SVG."
|
||||
f" Consider updating dvisvgm to at least version 2.4."
|
||||
f" If this does not solve the problem, please refer to our troubleshooting guide at:"
|
||||
f" https://manimce.readthedocs.io/en/latest/installation/troubleshooting.html"
|
||||
f" https://docs.manim.community/en/latest/installation/troubleshooting.html"
|
||||
)
|
||||
|
||||
return result
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ authors = ["The Manim Community Developers","3b1b <grant@3blue1brown.com>"]
|
|||
license="MIT"
|
||||
readme="README.md"
|
||||
repository="https://github.com/manimcommunity/manim"
|
||||
documentation="https://manimce.readthedocs.io/en/latest/"
|
||||
documentation="https://docs.manim.community/"
|
||||
classifiers= [
|
||||
"Development Status :: 4 - Beta",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue