Skip to content

Commit 530e2c6

Browse files
committed
add reference to manim_directive
1 parent 0fcaeb9 commit 530e2c6

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

docs/source/contributing.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,16 @@ Changing manim's Source Code
8787
with more information about how we prefer our code to be documented. The content
8888
of the docstrings will be rendered in the :doc:`reference manual <reference>`.
8989

90+
.. tip::
91+
92+
Use the :mod:`manim directive for Sphinx <.manim_directive>` to add examples
93+
to the documentation!
94+
95+
.. autosummary::
96+
:toctree: reference
97+
98+
manim_directive
99+
90100
#. *Add new or update existing tests.*
91101
Depending on the changes you are making you will need to update or add new tests.
92102
It is strongly preferred that you include tests with your PR. Details of our testing
@@ -183,8 +193,8 @@ community wants to merge your changes! Overall, in order for your PR to be merge
183193
at least two approving code reviews from core community developers are required.
184194

185195

186-
Further useful guideline
187-
========================
196+
Further useful guidelines
197+
=========================
188198

189199
#. When submitting a PR, please make special note of whether your proposed
190200
changes will result in breaking changes.

docs/source/manim_directive.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@ def construct(self):
7272

7373

7474
class ManimDirective(Directive):
75-
r"""The ``.. manim::`` directive.
75+
r"""The manim directive, rendering videos while building
76+
the documentation.
7677
7778
See the module docstring for documentation.
7879
"""

0 commit comments

Comments
 (0)