mirror of
https://github.com/searxng/searxng.git
synced 2025-07-24 21:59:22 +02:00
doc: reST primer -- describe admonitions & customize their CSS
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
e1566e68aa
commit
b82f61f704
2 changed files with 110 additions and 35 deletions
|
@ -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:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue