Skip to content

Update the Admonitions section #2348

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 4 commits into from
Sep 24, 2021
Merged

Update the Admonitions section #2348

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce82e93
Update admonitions
xuniq Sep 23, 2021
2319bc8
Minor fixes
xuniq Sep 24, 2021
40d5c45
Minor fix
xuniq Sep 24, 2021
525282d
Minor fix
xuniq Sep 24, 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
13 changes: 13 additions & 0 deletions doc/contributing/docs/markup/admonitions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ In Tarantool we have 3 variants of css-style for admonitions:
For example, in the description of :doc:`/reference/reference_lua/box_session/on_connect`
trigger we warn a user about some consequences of his actions.

* Important:

.. code-block:: rst

.. important::

.. important::

This block contains essential information that the user should know while doing something.

For example, the block :doc:`in Getting Started with Docker </getting_started/getting_started_go>` is used to warn the user against
closing the terminal window.

* Custom admonition:

.. code-block:: rst
Expand Down