ReStructuredText

Z Wikipedie, otevřené encyklopedie
Skočit na navigaci Skočit na vyhledávání

ReStructuredText (zkracováno ReST, reST i RST) je odlehčený značkovací jazyk k tvorbě technické dokumentace, který se rozšířil v komunitě kolem programovací jazyka Pythonu. Popularitu získal v rámci projektu vytvořit dokumentační nástroj pro Python podobný tomu, jakými jsou Javadoc pro Javu a POC pro Perl.

Byl vytvořen v roce 2002 a vychází z jazyka StructuredText, přičemž se snaží řešit jeho nedostatky.[1]

ReST je podporován mimo jiné dokumentačním systémem Sphinx a webovými rozhraními GitHubu a Bitbucketu. Od července 2016 se Sphinx a ReST rozhodli používat k dokumentaci vývojáři linuxového jádra místo DocBooku, který používali předtím. Také jej používá k dokumentaci projekt CMake.

Ukázka syntaxe[editovat | editovat zdroj]

Nadpisy[editovat | editovat zdroj]

 Nadpis kapitoly
 ===============
 
 Nadpis podkapitoly
 ------------------

Seznamy[editovat | editovat zdroj]

- první položka
- druhá položka

  - podpoložka

1) číslovaný seznam

2) druhá položka

   a) podpoložka roztažená na více
      řádků musí dodržovat odsazení
      svého prvního řádku

      i) Položky seznamu mohou zahrnout

         rozdělení do odstavců.

3) třetí položka

Obrázky[editovat | editovat zdroj]

.. image:: /path/to/image.jpg

Pojmenované odkazy[editovat | editovat zdroj]

Z této věty je odkázána `Wikipedie`_ a `Archiv jádra Linuxu`_.

.. _Wikipedie: https://www.wikipedia.org/
.. _Archiv jádra Linuxu: https://www.kernel.org/

Anonymní odkazy[editovat | editovat zdroj]

V této větě je `obsažen anonymní odkaz na stránky Pythonu`__.

__ https://www.python.org/

Doslovné citace[editovat | editovat zdroj]

::

  doslovný text

.. code:: python

   print("Citace pythonového kódu")

Odkazy[editovat | editovat zdroj]

Reference[editovat | editovat zdroj]

V tomto článku byl použit překlad textu z článku reStructuredText na anglické Wikipedii.

  1. TIŠNOVSKÝ, Pavel. Rozsáhlý svět značkovacích jazyků. Root.cz [online]. 2020-03-17 [cit. 2020-11-05]. Dostupné online. ISSN 1212-8309. 

Externí odkazy[editovat | editovat zdroj]