Skip to content

Added :ref_methods: to the manim directive #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 31, 2021
Merged

Added :ref_methods: to the manim directive #1209

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3aece29
fix manim_directive for methods
kolibril13 Mar 31, 2021
6a90378
Merge branch 'master' into fix_directive
kolibril13 Mar 31, 2021
847bc26
added ref_methods to Angle example
kolibril13 Mar 31, 2021
c7eb7bc
black
kolibril13 Mar 31, 2021
aff1850
added new ref_methods references
kolibril13 Mar 31, 2021
a1f3a4d
Merge branch 'master' into fix_directive
jsonvillanueva Mar 31, 2021
e6095af
sort out ref_functions vs ref_methods in examples.rst
behackl Mar 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/source/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Animations

.. manim:: MovingAngle
:ref_classes: Angle
:ref_functions: Mobject.rotate
:ref_methods: Mobject.rotate

class MovingAngle(Scene):
def construct(self):
Expand Down Expand Up @@ -296,7 +296,7 @@ Animations
self.wait()

.. manim:: RotationUpdater
:ref_functions: Mobject.add_updater Mobject.remove_updater
:ref_methods: Mobject.add_updater Mobject.remove_updater

class RotationUpdater(Scene):
def construct(self):
Expand All @@ -317,7 +317,7 @@ Animations

.. manim:: PointWithTrace
:ref_classes: Rotating
:ref_functions: VMobject.set_points_as_corners Mobject.add_updater
:ref_methods: VMobject.set_points_as_corners Mobject.add_updater

class PointWithTrace(Scene):
def construct(self):
Expand Down
8 changes: 7 additions & 1 deletion docs/source/manim_directive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,11 @@ def construct(self):
rendered in a reference block after the source code.

ref_functions
A list of functions and methods, separated by spaces,
A list of functions, separated by spaces,
that is rendered in a reference block after the source code.

ref_methods
A list of methods, separated by spaces,
that is rendered in a reference block after the source code.

"""
Expand Down Expand Up @@ -133,6 +137,7 @@ class ManimDirective(Directive):
"ref_modules": lambda arg: process_name_list(arg, "mod"),
"ref_classes": lambda arg: process_name_list(arg, "class"),
"ref_functions": lambda arg: process_name_list(arg, "func"),
"ref_methods": lambda arg: process_name_list(arg, "meth"),
}
final_argument_whitespace = True

Expand Down Expand Up @@ -163,6 +168,7 @@ def run(self):
self.options.get("ref_modules", [])
+ self.options.get("ref_classes", [])
+ self.options.get("ref_functions", [])
+ self.options.get("ref_methods", [])
)
if ref_content:
ref_block = f"""
Expand Down