From b82f61f7044665b900b0d8f556cbe207f3133837 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Fri, 20 Dec 2019 11:01:41 +0100
Subject: doc: reST primer -- describe admonitions & customize their CSS

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/dev/reST.rst | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 68 insertions(+), 4 deletions(-)

(limited to 'docs/dev')

diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index 5522f9e15..69e4a9305 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -16,8 +16,6 @@ generated and deployed at :docs:`github.io <.>`.
 The sources of Searx's documentation are located at :origin:`docs`.  Run
 :ref:`make docs-live <make docs-live>` to build HTML while editing.
 
-------
-
 .. sidebar:: Further reading
 
    - Sphinx-Primer_
@@ -36,8 +34,6 @@ The sources of Searx's documentation are located at :origin:`docs`.  Run
    :local:
    :backlinks: entry
 
-------
-
 Sphinx_ and reST_ have their place in the python ecosystem.  Over that reST is
 used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_.
 
@@ -593,6 +589,74 @@ Further list blocks
 - doctest blocks (:duref:`ref <doctest-blocks>`)
 
 
+Admonitions
+===========
+
+Admonitions: :dudir:`hint`, :dudir:`note`, :dudir:`tip` :dudir:`attention`,
+:dudir:`caution`, :dudir:`danger`, :dudir:`error`, , :dudir:`important`, ,
+:dudir:`warning` and the generic :dudir:`admonition <admonitions>`.
+
+.. code:: reST
+
+   .. admonition:: generic admonition title
+
+      lorem ipsum ..
+
+   .. hint::
+
+      lorem ipsum ..
+
+   .. note::
+
+      lorem ipsum ..
+
+   .. warning::
+
+      lorem ipsum ..
+
+
+.. admonition:: generic admonition title
+
+   lorem ipsum ..
+
+.. hint::
+
+   lorem ipsum ..
+
+.. note::
+
+   lorem ipsum ..
+
+.. tip::
+
+   lorem ipsum ..
+
+.. attention::
+
+   lorem ipsum ..
+
+.. caution::
+
+   lorem ipsum ..
+
+.. danger::
+
+   lorem ipsum ..
+
+.. important::
+
+   lorem ipsum ..
+
+.. error::
+
+   lorem ipsum ..
+
+.. warning::
+
+   lorem ipsum ..
+
+
+
 .. _KISS: https://en.wikipedia.org/wiki/KISS_principle
 .. _readability: https://docs.python-guide.org/writing/style/
 .. _Sphinx-Primer:
-- 
cgit v1.2.3