Commit graph

28 commits

Author SHA1 Message Date
Nikhil Garuda
c82f84ce7d
Update of rate_functions (#1486)
* Added a new image

* Updated the example and deleted the static image.

* Update rate_functions.py

* Update rate_functions.py

* Apply suggestions from code review

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-12 15:17:06 +02:00
Anton Ballmaier
2d2604bca9
Add inheritance diagrams to reference page (#1441)
* test

* revert test changes

* add inheritance map

* Configure Graph to fit dark theme

* Add inheritance graphs to each section in reference

* Responsive color scheme

* remove unnecessary comment

* remove more stuff from testing

* and more still

* Update docs/source/_static/responsiveSvg.js

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

* Add graphviz explanation to docs

* add background color fix for chrome

* Add subheadings

* Chnaged Headings to singular and bold

Apply suggestions from code review

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-06 12:31:02 +02:00
Benjamin Hackl
4fc00f7318
Switch documentation from guzzle-sphinx-theme to furo (#1251)
* prototype: switch from guzzle-sphinx-theme to furo

* try workaround for displaying navbar elements

* more specific css targeting

* further color adjustments

* manim-example block: larger font size

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

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

* remove unused import

* increase font size for references

* fix hover colors

* html_title with explicit version

* [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>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-08 20:18:02 -07:00
Jason Villanueva
a87bb28484
Refactored the Command Line Interface to use Click + Cloup instead of Argparse (#1013)
* Added click dependency and command structure

* Refactored code for separation of concerns

* Shortened plugins command to plugin, added render options

* first draft for render -h

* First successful render using click

* Cleaned main

* Moved flush_cache to option, ran black

* Removed argparse logic, scattered print statements

* corrected tests, all passing

* merge upstream

* fixed test with click's clirunner

* Fixed doctest configuration.rst

* Temporarily add in main_utils

* Removed main_utils.parse_args, used ManimConfig.digest_args

* fixed progress bar

* Fix jupyter

* black

* Fixed incorrectly merged merge conflict

* updated README command.png image

* updated configuration.rst expected output

* Fixed test_plugins and config_file expected type

* Refixed the jupyter fix

* Apply 3/5 suggestions

Remove stray print

Improve readability of test code

Added module docs for the subcommands

* Updated `main` to `manim` for tests

* Forced `file` positional argument to be Path type

* Fixed main -> manim

* Added libpango to linux dependency

* Updated poetry.lock

* Changed configuration.rst test

* Fixed test_a_flag test

minor space issue

added media_width to configuration.rst

* Fixed fps flag in Cairo rendering

* Fixed more outdated rst in sphinx docs

Removed default for fps option, always overwrote quality

Fixed doctest control_data

* Fixed more incorrect rst orderings

* Update tests/test_commands.py

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

* Added suggestions

* Removed unused imports

* Reverted entry point back to main

* Update manim/_config/default.cfg

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

* Adjusted ipython_magic's call to the entry_point

* Converted frame_rate to int if integer

* run black

* Fixed doctest

* Fixed issue with command name from CliRunner

* Fixed multiple video windows opening from upstream merge

* to black or not to black

* Added deprecation warning to render subcommand

* warning instead of warn

* Applied Naveen's suggestions

* Made `manim render` show the help page

* Update manim/cli/render/commands.py

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

* Update manim/cli/cfg/commands.py

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

* Update manim/cli/cfg/commands.py

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

* Update manim/cli/plugins/commands.py

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

* Addressed some style changes

* add back in write_to_movie temporarily for OpenGL support

* Removed sound flag, deprecated use_opengl_renderer, added renderer option

* revert webgl_renderer_path removal

* Fixed cfg export

Fixed readme usage of CLI

* Flake8/black

* Fixed bug in setting renderer choice

* Removed log message due to default option

Removed default option of background color

Fixed write_to_movie flag default

* Fix log_to_file tests

* Make '-c' option for config_file, not background_color

* print colored version always

* Remove -v = --version shorthand, conflicts with verbosity

* Use subprocess.run instead of Click's CliRunner for stdout

* Refactor cli/render to use Cloup instead of click-option-group

1) There's a new file for each option group
2) render is now a cloup.Command, not a Group

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

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

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

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

* Update tests/assert_utils.py

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

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

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

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

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

* Update tests/assert_utils.py

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

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Fixed unnecessary args dict

* Fixed bug that changed caching hashing result

* Revert doctest logic for fps filename output

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Gianluca Gippetto <gianluca.gippetto@gmail.com>
2021-04-01 23:53:07 -07: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
kolibril13
cdd0dded6a
Added sounds example to docs (#1188)
* added sound example to docs

* update docstring
2021-03-28 19:49:15 +02:00
Benjamin Hackl
9a39701f79
More color changes (#706)
* change "primary color" from green to blue

* change color of several admonition blocks to our logo palette
2020-11-14 11:52:28 -05:00
Safin Singh
6addeccadf
Clean up README (#586)
* Clean up README

* update flags

* Apply suggestions from code review

* updated command.png

* removed redundant files from readme-asserts and used files from docs/_static instead

* change to relative parts

Co-authored-by: Leo Torres <leo@leotrs.com>
Co-authored-by: kolibril13 <jan-hendrik.mueller@gmx.net>
2020-11-10 13:28:50 +01:00
Benjamin Hackl
912ab0ec54
Anchors for example blocks in documentation (#658)
* add anchors to example blocks

* fix save_as_gif in manim_directive
2020-11-01 14:04:49 +05:30
Benjamin Hackl
1d56066af4 change colors of "see also" blocks 2020-10-31 16:43:05 +01:00
Benjamin Hackl
4e8680edb8 custom styling for module-level functions 2020-10-31 16:12:00 +01:00
Naveen M K
c6b4c1ea4a
Add a favicon 2020-10-29 13:56:21 +05:30
Benjamin Hackl
1d863e469d
Improve design of documentation (#617)
* redesign documentation \o/

* outline 0 for videos

* forgot border-color for source blocks

* adapt styling for example references

* change link and text color

* suggestion for new order of top-level docs

* mathematical objects --> mobjects
2020-10-27 19:54:03 +01:00
Benjamin Hackl
1a6b0c269d
Custom "Example reference"-blocks for examples with manim directive (#607)
* add seealso options to manim directive

* illustrate use of seealso_classes

* remove unneeded import

* rename: seealso -> ref

* custom styling

* change to ref_classes in example
2020-10-24 23:01:36 +02:00
Benjamin Hackl
3c13ceb1db change png to svg 2020-10-21 00:31:13 +02:00
Benjamin Hackl
da875bb8e2 add new logo to documentation 2020-10-20 20:27:46 +02:00
nilaybhatia
2ef6194415 Add an image of non-standard rate funcs to docs 2020-10-06 23:50:58 +05:30
Naveen M K
ec059ccf29
Align Images in Mobile - Sphinx (#440) 2020-09-13 08:30:36 -04:00
Benjamin Hackl
e6e8cd94da
delete static files (#436) 2020-09-12 15:44:06 -04:00
Leo Torres
e48d46717b
New tutorial: manim internals basic (#394)
* add a section to the quickstart explaining the basics of building a scene

* add the internals_basic tutorial. Currently contains the section for Mobjects only

Co-authored by @behackl

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2020-09-12 11:51:12 -04:00
Benjamin Hackl
9c511502cc
Render videos while building documentation (#402)
Implement a sphinx directive to allow for rendering video at the time of generating the documentation
2020-09-11 16:22:06 -04:00
Benjamin Hackl
d470a8d92a
Fix overflowing images in documentation (#392)
* add width and some margin-bottom to img.align-center, change spacing
2020-08-31 14:49:12 -04:00
Leo Torres
662777bb96
Docs (#347)
* add some module docstrings

* add some breathing room in the generated autosummaries

* edit template so it generates cleaner output

* document add and remove

* document new conf.py option

* updates from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2020-08-28 09:20:21 -04:00
leotrs
46fa54e565 symlinks dont work on windows 2020-08-22 13:18:10 -04:00
Leo Torres
271c235f78
Documentation: finish quickstart and add installation instructions (#324)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

* update contributing guidelines

* convert quickstart doc from md to rst. Also add a troubleshooting stub file

* finish the second part of the quickstart

* add general and linux instructions

* add mac instructions

* add windows install instructions

* final touches

* Update docs/source/installation/win.rst

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

* Update a_deeper_look.rst

added explanation on the  ``-s`` flag

* Update docs/source/installation/installation_linux.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* updates from code review

* update from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
2020-08-21 20:40:27 -04:00
kolibril13
2752a47279 added changelog an gifs 2020-08-15 15:31:56 +02:00
kolibril13
ba418692f9 # Restructured the docs-chapters 2020-08-15 12:57:38 +02:00
leotrs
e1f97335b9 1: make sphinx accept markdown files. 2: add a changelog stub file. 3: add a sample quickstart text that shows how to include .gif files. 2020-08-10 14:48:48 -04:00