Skip to content

Commit 5f1979b

Browse files
committed
[IMP] contributing/doc: add an entry for the example admonition
closes #1533 X-original-commit: ddff8f6 Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
1 parent 6fb40b6 commit 5f1979b

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

content/contributing/documentation/rst_cheat_sheet.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,25 @@ Render
403403
.. tip::
404404
Use this admonition to inform the reader about a useful trick that requires an action.
405405

406+
.. _contributing/example:
407+
408+
Example
409+
-------
410+
411+
RST
412+
~~~
413+
414+
.. code-block:: rst
415+
416+
.. example::
417+
Use this admonition to show an example.
418+
419+
Render
420+
~~~~~~
421+
422+
.. example::
423+
Use this admonition to show an example.
424+
406425
.. _contributing/exercise:
407426

408427
Exercise
@@ -414,7 +433,7 @@ RST
414433
.. code-block:: rst
415434
416435
.. exercise::
417-
Use this admonition to suggest an exercise to the reader.
436+
Use this admonition to suggest an exercise to the reader.
418437
419438
Render
420439
~~~~~~

0 commit comments

Comments
 (0)