Added :ref_methods: to the manim directive #1209
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kolibril13
commented
Mar 31, 2021
jsonvillanueva
approved these changes
Mar 31, 2021
|
If you don't mind, I'll push a commit to rewrite the others as well to this PR. It's a simple search and replace, so there isn't really a reason to delay this to a follow-up PR. |
|
... now done in e6095af. |
behackl
approved these changes
Mar 31, 2021
jsonvillanueva
changed the title
jsonvillanueva
added
documentation
jsonvillanueva
changed the title
jsonvillanueva
pushed a commit
to jsonvillanueva/manim
that referenced
this pull request
Apr 1, 2021
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. (ManimCommunity#1192) * fixed issue * fixed tests * Update manim/renderer/cairo_renderer.py Co-authored-by: Darylgolden <[email protected]> * 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 <[email protected]> * Update tests/assert_utils.py Co-authored-by: Naveen M K <[email protected]> Co-authored-by: KingWampy <[email protected]> Co-authored-by: Darylgolden <[email protected]> Co-authored-by: Naveen M K <[email protected]> Added :ref_methods: to the manim directive (ManimCommunity#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 <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]> Fixed issue when an animation is cached, manim can't merge the partial movie files. (ManimCommunity#1192) * fixed issue * fixed tests * Update manim/renderer/cairo_renderer.py Co-authored-by: Darylgolden <[email protected]> * 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 <[email protected]> * Update tests/assert_utils.py Co-authored-by: Naveen M K <[email protected]> Co-authored-by: KingWampy <[email protected]> Co-authored-by: Darylgolden <[email protected]> Co-authored-by: Naveen M K <[email protected]> Added :ref_methods: to the manim directive (ManimCommunity#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 <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]> Fixed unnecessary args dict
jsonvillanueva
added a commit
that referenced
this pull request
Apr 2, 2021
… 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 <[email protected]> * Added suggestions * Removed unused imports * Reverted entry point back to main * Update manim/_config/default.cfg Co-authored-by: Benjamin Hackl <[email protected]> * 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 <[email protected]> * Update manim/cli/cfg/commands.py Co-authored-by: Naveen M K <[email protected]> * Update manim/cli/cfg/commands.py Co-authored-by: Naveen M K <[email protected]> * Update manim/cli/plugins/commands.py Co-authored-by: Naveen M K <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Update tests/assert_utils.py Co-authored-by: Naveen M K <[email protected]> Co-authored-by: KingWampy <[email protected]> Co-authored-by: Darylgolden <[email protected]> Co-authored-by: Naveen M K <[email protected]> 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 <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]> 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 <[email protected]> * 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 <[email protected]> * Update tests/assert_utils.py Co-authored-by: Naveen M K <[email protected]> Co-authored-by: KingWampy <[email protected]> Co-authored-by: Darylgolden <[email protected]> Co-authored-by: Naveen M K <[email protected]> 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 <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]> Fixed unnecessary args dict * Fixed bug that changed caching hashing result * Revert doctest logic for fps filename output Co-authored-by: Naveen M K <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]> Co-authored-by: Gianluca Gippetto <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows class methods to be linked in the documentation. Checkout the
example references <https://docs.manim.community/en/latest/examples.html#movingaround>_ below the code to see how this is used!Fixes #1208.
ref_methods was missing in the main directive which caused broken links in the docs, see e.g. here:
https://docs.manim.community/en/latest/examples.html#rotationupdater