From 6778f7204d11c0ca9d6dd36631f38c0f0c70f02b Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Thu, 3 Feb 2022 14:22:33 +0000 Subject: [PATCH] [IMP] contributing/doc: add an entry for the `example` admonition closes odoo/documentation#1530 X-original-commit: ddff8f691430b496eadd784e6b996ec80c185b1b Signed-off-by: Antoine Vandevenne (anv) --- .../documentation/rst_cheat_sheet.rst | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/content/contributing/documentation/rst_cheat_sheet.rst b/content/contributing/documentation/rst_cheat_sheet.rst index 20da7407c..dc50dc0c3 100644 --- a/content/contributing/documentation/rst_cheat_sheet.rst +++ b/content/contributing/documentation/rst_cheat_sheet.rst @@ -403,6 +403,25 @@ Render .. tip:: Use this admonition to inform the reader about a useful trick that requires an action. +.. _contributing/example: + +Example +------- + +RST +~~~ + +.. code-block:: rst + + .. example:: + Use this admonition to show an example. + +Render +~~~~~~ + +.. example:: + Use this admonition to show an example. + .. _contributing/exercise: Exercise @@ -414,7 +433,7 @@ RST .. code-block:: rst .. exercise:: - Use this admonition to suggest an exercise to the reader. + Use this admonition to suggest an exercise to the reader. Render ~~~~~~