Commit graph

30 commits

Author SHA1 Message Date
Darylgolden
6018ebf445 Revert "Merge branch 'main' of https://github.com/ManimCommunity/manim"
This reverts commit e7f9d23aa7, reversing
changes made to afe91d02b6.
2023-07-31 15:29:39 +08:00
Benjamin Hackl
a3b1d9f2ff
replace mentions of Python 3.7 as the minimally required version with 3.8 (#3274) 2023-07-05 00:02:11 +09:00
Pavel Zwerschke
63cc40120d
Add conda installation docs (#2914)
* Add conda installation docs

* MacOS -> macOS

* Add Working with Manim section

* Small fixes

* maybe the refs work now?

* why is ci stuck?

* Lets see if this works...

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen521kk@gmail.com>
2022-08-31 13:11:34 +00:00
Benjamin Hackl
48747a74d9
Refactored structure of documentation; added :doc:FAQ section <faq/index> (#2732)
* move tutorials -> tutorials_guide

* change title in tutorials_guides

* rename: a_deeper_look -> output_and_config

* splitting Tutorials

* reorder index (sidebar), move some top level sections elsewhere

* rename some tutorials

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* replace recommonmark with rest for rendering md files

* fixed broken references

* fixed **all** warnings and errors during docbuild

* faq: help, more structure for landing page

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix deprecation tests

* prepare some sort of skeleton for installation faq

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* ensure that pip from poetry venv is used in pipeline

* added myst-parser as dev dependency

* remove fixed sphinx version from requirement.txt, don't re-install dependencies

* move and improve versions and troubleshooting content to FAQ

* resolve broken references

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* help blacken-docs

* new: navigating the docs

* make different versions question more prominent

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fixed order of tutorials

* added explicit references to building blocks and quickstart tutorial

* docs -> doc

* change a page-reference to a paragraph-reference

* pypi manimlib, split answer regarding chocolatey failing

* added a note on #beginner-resources

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-05-27 08:45:31 +00:00
Benjamin Hackl
a2b21df42b
Updated Python version requirement in installation guide (#2482) 2022-01-23 21:48:37 +05:30
Ricky
34f01346b8
Mention installation of manim sideview extension (#2350)
* Mention manim sideview extension 

updates:
    - added a brief notice for installing manim sideview

* segregate mention into a different section

* added a new section called Editors
* moved the mention into the section

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* change repetition of extension to pronoun

* word change

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update docs/source/installation.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update docs/source/installation.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-12-03 20:59:44 +00:00
Lucas Ricci
18a0ef504b
Clarified that Manim does not support Python 3.10 yet in the documentation (#2310)
* warn that manim doesn't support python 3.10 yet added

* warning that manim does not support python 3.10 yet, was added

* changed the warning to a separate paragraph and rephrased it

* a few typo corrections, I also changed the other files that were was saying that manim supports python 3.7+, when actually is just 3.7-3.9

* Changed normal hyphens (-) to en dashes (–), and remove a space before and after a dash.
2021-11-20 15:56:19 +08:00
GameDungeon
94821c10d8
Flake8 Changes + Fixing Warnings (#1968)
* Warning Removal

* Flake Stuff

* HotFix

* Docs Fix

* I'm Dumb

* Docs Fix 2

* Fixing Github Requests

* Fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* quick fix

* Add Deprecation Warning

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Weird Pre Commit Stuff

* Quick Fix

* Quick Fix

* Fix

* Flake Fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-09-03 13:45:48 -04:00
Benjamin Hackl
89bcec8f2f
Reworked installation instructions (#1949)
* move plugins

* plugins in main sidebar

* restructure installation guide

* fix some removed references

* more sphinx fixes

* restructured developer installation, more cleanup

* rename some files

* rewrote MacOS installation instructions

* rewrote the windows installation guide

* cleaned up linux installation instructions

* added a lot of colons

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* improve first paragraph of installation.rst

* move docker and jupyter to separate files

* Copyediting

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* change wording regarding colab env

* copyediting, second pass

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* first mention recommended ffmpeg installation for windows

* move admonition above table of contents

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-08-28 12:50:29 +00:00
Darylgolden
ed64149aa3
Updated installation instructions (#1807)
* Update installation section

* Indent

* Update admonition

* Update installation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-08-02 14:12:59 +08:00
Darylgolden
da40bfdc70
Update python requirement (#1658) 2021-06-09 12:28:44 +08:00
Skaft
40bfc27dd2
Fixing broken links and other minor doc things (#1541)
* fix typos

* lowercasing note admonition

* fixing broken links

* fixing title underlines being too short
2021-05-19 05:56:32 -05:00
Darylgolden
2aaec7ab31
Update troubleshooting docs (#1508)
* Update troubleshooting

* link in installation docs

* change section header

* textmobject -> text and texmobject -> tex

* note

* Fix formatting

* formatting

* formatting

* section

Co-authored-by: Philipp Imhof <52650214+PhilippImhof@users.noreply.github.com>
2021-05-14 19:44:23 +05:30
Benjamin Hackl
7f17ea6d24
Fixed all current docbuild warnings (#1424)
* fix all current docbuild warnings

* Rerun rtd

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-29 19:04:08 -07:00
kolibril13
2b6b2cddcc
Added example jupyter notebook into the examples folders (#1029)
* example notebook

* removed cell output

* added jupyter/ folder to gitignore

* added link to binder in documentation

* Update docs/source/installation.rst

* updated binder links in readme

* Update example_scenes/manim_jupyter_example.ipynb

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update example_scenes/manim_jupyter_example.ipynb

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update docs/source/installation.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* added config.media_width = "10vw"

* updated notebook to latest version

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-08 10:36:18 +02:00
Darylgolden
45afef3ce4
Added documentation explaining the differences between manim versions (#1268)
* Added documentation explaining the differences between manim versions

* Attempt to fix link

* Attempt to fix link again

* Attempt to fix link yet again

* Attempt to fix more links

* more fix attempts

* Apply suggestions from code review

Co-authored-by: Oliver <44864613+PhotonSpheres@users.noreply.github.com>

* Uncapitalized Manim

* fix

* Add link to manimgl documentation

* make names of different manim versions (more) consistent

Co-authored-by: Oliver <44864613+PhotonSpheres@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-07 20:44:28 +02:00
Jason Villanueva
54ead3b61f
Added pre-commit to run black and flake8, updated contributing documentation accordingly (#1130)
* Added precommit for black, updated contributing documentation

Updated contributing.rst and related files

Fixed some grammar, added pre-commit section

* picked pre-commit version, removed redundant language_version

* Fix section headings

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Add in missing flake stuff to lock

* Added flake8 to pre-commit

* added newlines at the end of .flake8 and .pre-commit-config.yaml

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Reorder mentioning of tests after writing code

* Removed extra -

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-30 14:33:59 +05:30
Darylgolden
71a05e82b9
Added documentation for installing Manim on Colab (#1165)
* Flake8 fix

* Revert "Flake8 fix"

This reverts commit fc1a083be5.

* Add documentation for installing manim on colab

* Update docs/source/installation/colab.rst

* Fixed installation documentation

* Fix installation instructions

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-03-27 10:24:43 +01:00
kolibril13
e527328a02
Documentation: move installation instructions for developers to page for developers (#923)
* Update installation.rst

* reordered instruction

* Update docs/source/installation/for_dev.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-01-26 14:45:56 +01:00
Jason Villanueva
c8c1f68cb3
Feature plugins (#784)
* Added examples, documentation, assets_dir config

* Removed CLI

* Update docs/source/installation/win.rst

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Lazy commit

* Adds plugin command/functionality

* Removed erroneous parameter from manim plugins -l

* Updated documentation for plugins

* black

* Update manim/_config/main_utils.py

consolidate manim subcommands

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Update docs/source/installation/plugins.rst

accessible documentation

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Update manim/plugins/__init__.py

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Update docs/source/installation/plugins.rst

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Update docs/source/installation/plugins.rst

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* revert numpy versioning

* Removed documentation on plugins --update flag

* Removed plugins --update, moved plugins_flags

* Slight improvement to documentation

* Removed leftover update, added suggestions

Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2020-12-05 00:01:16 +05:30
kolibril13
7fe79e36ec
manimce to manim & capitalizing Manim in readme (#794) 2020-12-04 02:08:55 +01:00
allc
2a2740420e
Fix typo in installation.rst (#702) 2020-11-13 10:24:47 -05:00
Benjamin Hackl
7a7e9cbd57
Bring back support for docker (#681)
* add first version of dockerfile and corresponding texlive.profile

* add reference to docker in the installation docs

* rename textlive.profile -> texlive-profile.txt

* newline at end of file

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* remove libpango1.0-dev

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* add docker badge to readme, fix links for badges

* let banner link to manim.community

* Fix broken link

* Docker images --> docker images

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2020-11-10 21:55:41 +01:00
Benjamin Hackl
8553e72822
fix formatting of warning block in installation.rst (#428) 2020-09-11 08:12:09 -04:00
Naveen M K
88f8252b4b
Move to Poetry (#165)
* Add necessary files and fix readme

* remove poetry.lock

* Change some things

* Add Github action to Publish

* Specify rich version - updates in setup.py

* Add lock file

* Add some docs about poetry

* Add some docs and upgrade rich

* remove Setup.py

* Github Action using Poetry

* Fix tests

* Move to py 3.7 until poetry fixes it

* Remove 3.6

* Looks like 3.6 works now

* Fix Path for CI

* Windows build

* Add CI that actually works

* Fix some spaces

* Update docs and fix windows test

* Fix windows run

* Change some formatting -Docs

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Some docs update

* Change doc url Pyproject - Some formatting docs - change ci on release event

* Change to manimlib

CC. https://github.com/ManimCommunity/manim/pull/165#discussion_r481128270

* Some formatting changes

* Merge branch 'master' of https://github.com/ManimCommunity/manim into poetry-change-new

* Remove pytest.ini and Have a note in Readme

* Update some docs

* Update Authors field

* Make readthedocs work

Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2020-09-10 08:59:34 -04:00
CorvidCanine
95ff9f89d6
Rewrite contributing guide and add two troubleshooting soulutions (#384)
* Move bug report guide to own page, rewrite contributing guide, add a troubleshooting solution

* Apply suggestions from code review of contributing guide rewrite

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Change contributing guide to checkout master

Instead of saying how to checkout any branch, change contributing.md to say how to checkout the master branch specifically.

Co-authored-by: Naveen M K <naveen@syrusdark.website>
2020-09-05 11:17:36 -04:00
Aathish Sivasubrahmanian
4b309a316a
Add a note asking the dev to uninstall pip manimce if using git version. (#382)
* add docs reqs for RTD site, and update the output of 'manim --help' to fix doctests

* Add a note asking the dev to uninstall pip manimce if using git version.

* Fix a typo.

Co-authored-by: leotrs <leo@leotrs.com>
2020-08-31 11:09:35 -04:00
leotrs
ef9562843c add installation instructions 2020-08-21 21:32:11 -04:00
leotrs
beec7ed6f5 link back to the correct page 2020-08-21 21:28:45 -04:00
Leo Torres
aada9f00f0
Change the folder of auto-generated reference from _autosummary to reference. This will change the URLs as well so they look prettier. I also moved the installation/examples/tutorials indices one folder up so the URLs look less messy and more straightforward as well. (#312) 2020-08-17 07:43:52 -04:00