Skip to content

[FW][IMP] contributing/doc: add an entry for the example admonition #1533

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

Closed
wants to merge 1 commit into from
Closed

[FW][IMP] contributing/doc: add an entry for the example admonition #1533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 20 additions & 1 deletion content/contributing/documentation/rst_cheat_sheet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
~~~~~~
Expand Down