reStructuredText - reStructuredText
 | |
| Přípona názvu souboru |
.rst
|
|---|---|
| Typ internetového média | text / x-první |
| Vyvinul | David Goodger |
| První vydání | 2. dubna 2002 |
| Poslední vydání | Revize 8407 (29. října 2019 ) |
| Otevřený formát ? | Veřejná doména |
| webová stránka | docutils |
reStructuredText ( RST , ReST nebo reST ) je formát souboru pro textová data používaný především v komunitě programovacího jazyka Python pro technickou dokumentaci .
Je součástí projektu Docutils Pythonu Doc-SIG (Documentation Special Interest Group), jehož cílem je vytvoření sady nástrojů pro Python podobných Javadocu pro Javu nebo Plain Old Documentation (POD) pro Perl . Docutils může extrahovat komentáře a informace z programů Pythonu a formátovat je do různých forem dokumentace programu.
V tomto smyslu je reStructuredText lehký značkovací jazyk navržený tak, aby byl (a) zpracovatelný softwarem pro zpracování dokumentace, jako je Docutils, a (b) snadno čitelný lidskými programátory, kteří čtou a píší zdrojový kód Pythonu .
Dějiny
S dřívějším odlehčeným značkovacím jazykem StructuredText (vyvinutým společností Zope ) došlo k řadě problémů a pro jejich řešení byl vyvinut reST. Název reStructuredText byl zvolen k označení, že reST je „revidovaný, přepracovaný a znovu interpretovaný StructuredText.“
reST začal být v komunitě Pythonu významně využíván v roce 2002.
Referenční implementace
Referenční implementace analyzátoru reST je součástí rámce zpracování textu Docutils v programovacím jazyce Python , ale jsou k dispozici i další analyzátory.
Pro ReStrukturovaný text není registrován žádný oficiální typ mime, ale neoficiální ano text/x-rst .
Aplikace
reStructuredText se běžně používá pro technickou dokumentaci, například v dokumentaci knihoven Pythonu. Je však vhodný pro širokou škálu textů.
Od roku 2008 je reST klíčovou součástí systému Python pro generování dokumentů Sphinx .
Trac také podporuje reStructuredText, stejně jako GitHub a Bitbucket .
V roce 2011 společnost Distributed Proofreaders , která připravovala texty pro projekt Gutenberg , zvažovala přijetí reST jako základního formátu, ze kterého by bylo možné generovat další formáty e-knih.
V červenci 2016 se projekt jádra Linuxu rozhodl přejít z dokumentace založené na DocBooku na reStructuredText a nástrojovou řadu Sphinx .
Softwarový nástroj stavět CMake přešel z jazyka vlastního značkovací na reStructuredText ve verzi 3.0 pro jeho dokumentaci.
Příklady značení reST
Záhlaví
Section Header ============== Subsection Header -----------------
Seznamy
- A bullet list item
- Second item
- A sub item
- Spacing between items separates list items
* Different bullet symbols create separate lists
- Third item
1) An enumerated list item
2) Second item
a) Sub item that goes on at length and thus needs
to be wrapped. Note the indentation that must
match the beginning of the text, not the
enumerator.
i) List items can even include
paragraph breaks.
3) Third item
#) Another enumerated list item
#) Second item
snímky
.. image:: /path/to/image.jpg
Pojmenované odkazy
A sentence with links to `Wikipedia`_ and the `Linux kernel archive`_.
.. _Wikipedia: https://www.wikipedia.org/
.. _Linux kernel archive: https://www.kernel.org/
Anonymní odkazy
Another sentence with an `anonymous link to the Python website`__.
__ https://www.python.org/
Pozn .: pojmenované odkazy a anonymní odkazy jsou uzavřeny v závažných akcentech (`), nikoli v apostrofech (').
Doslovné bloky
::
some literal text
This may also be used inline at the end of a paragraph, like so::
some more literal text
.. code:: python
print("A literal block directive explicitly marked as python code")
Viz také
- Porovnání značkovacích jazyků dokumentů
- Porovnání generátorů dokumentace
- Porovnání softwaru pro psaní poznámek
Reference
externí odkazy
