ReStructuredText - ReStructuredText

Nesmí být zaměňována s Převod reprezentačního stavu.
reStructuredText
logo reStructuredText
Přípona názvu souboru
.rst
VyvinulDavid Goodger
První vydání2. dubna 2002; Před 18 lety (2002-04-02)
Poslední vydání
Revize 8407
(29. října 2019; Před 13 měsíci (2019-10-29))
Otevřený formát ?Veřejná doména
webová stránkadocutils.readthedocs.io/ en/ sphinx-docs/uživatel/ první/rychlý start.html

reStructuredText (RST, Zbyteknebo zbytek) je formát souboru pro textová data používaný především v Programovací jazyk Python komunita pro technická dokumentace.

Je součástí projektu Docutils Python Doc-SIG (Documentation Special Interest Group), jehož cílem je vytvořit sadu nástrojů pro Python podobnou Javadoc pro Jáva nebo Prostá stará dokumentace (POD) pro Perl. Docutils může extrahovat komentáře a informace z programů Pythonu a formátovat je do různých forem programové dokumentace.[1]

V tomto smyslu je reStructuredText a lehký značkovací jazyk navrženy tak, aby byly (a) zpracovatelné softwarem pro zpracování dokumentace, jako je Docutils, a (b) snadno čitelné lidskými programátory, kteří čtou a píší Python zdrojový kód.

Dějiny

S dřívějším odlehčeným značkovacím jazykem StructuredText (vyvinutý společností.) Došlo k řadě problémů Zope ) a pro jejich řešení byl vyvinut reST.[2] Název reStructuredText byl zvolen k označení, že reST je „revidovaný, přepracovaný a znovu interpretovaný StructuredText.“[3]

reST začal být v komunitě Pythonu významně využíván v roce 2002.[Citace je zapotřebí ]

Referenční implementace

Referenční implementace reST analyzátor je součástí rámce pro zpracování textu Docutils v Programovací jazyk Python, ale k dispozici jsou i další analyzátory.

Pro ReStrukturovaný text není registrován žádný oficiální typ mime, ale neoficiální ano text / x-první.[4]

Aplikace

reStructuredText se běžně používá pro technickou dokumentaci, například v dokumentaci knihoven Pythonu.[5] Je však vhodný pro širokou škálu textů.

Od roku 2008 je reST klíčovou součástí Pythonu Sfinga systém generování dokumentů.

Trac také podporuje reStructuredText,[6] stejně GitHub a Bitbucket.

V roce 2011, Distribuované korektory, která připravovala texty pro Projekt Gutenberg, zvažoval přijetí reST jako základního formátu, ze kterého by bylo možné generovat další formáty e-knih.[7][potřebuje aktualizaci ]

V červenci 2016 Linuxové jádro projekt se rozhodl přejít z DocBook dokumentace založená na reStructuredText a Sfinga řetězec nástrojů.[8]

Nástroj pro sestavení softwaru CMake ve své dokumentaci přešel z vlastního značkovacího jazyka na reStructuredText ve verzi 3.0.[9]

Příklady značení reST

Záhlaví

Záhlaví sekce =============== Záhlaví podsekce -----------------

Seznamy

- Položka seznamu odrážek- Druhá položka - Podpoložka- Mezery mezi položkami oddělují položky seznamu* Různé symboly odrážek vytvářejí samostatné seznamy- Třetí položka1) Výčet položky seznamu2) Druhá položka a) Dílčí položka, která pokračuje dál a je tedy třeba ji zabalit. Všimněte si odsazení, které musí odpovídat začátku textu, nikoli výčtu. i) Položky seznamu mohou dokonce obsahovat konce odstavců.3) Třetí položka#) Další výčet položky seznamu#) Druhá položka

snímky

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

Pojmenované odkazy

Věta s odkazy na `Wikipedia`_ a `Archiv linuxového jádra`_... _Wikipedia: https://www.wikipedia.org/.. _Linuxový archiv jádra: https://www.kernel.org/

Anonymní odkazy

Další věta s `anonymní odkaz na webovou stránku Pythonu`__.__ https://www.python.org/

Pozn .: pojmenované odkazy a anonymní odkazy jsou uzavřeny v závažných akcentech (`), nikoli v apostrofech (').

Doslovné bloky

::  nějaký doslovný textTo může být také použito na konci odstavce, například::  nějaký doslovnější text.. kód:: tisk v pythonu („Direktiva doslovného bloku výslovně označená jako kód pythonu“)

Viz také

Reference

  1. ^ Mertz, David (01.02.2003). „XML Matters: reStructuredText“. IBM developerWorks. Citováno 2016-10-05.
  2. ^ Goodger, David (2016-05-24). "reStructuredText: Markup Syntax and Parser Component of Docutils". Projekt Docutils. Citováno 2016-10-05.
  3. ^ Goodger, David (26.02.2016). „Docutils FAQ (často kladené otázky)“. Projekt Docutils. Citováno 2016-10-05.
  4. ^ „Jaký je oficiální typ MIME pro data reStructuredText? V Docutils FAQ“. Projekt Docutils. Citováno 2017-12-20.
  5. ^ Goodger, David (02.04.2002). „PEP 287 - formát dokumentu reStructuredText“. Softwarová nadace Python. Citováno 2016-10-05.
  6. ^ „podpora reStructuredText v Tracu“. Trac. 2016-09-13. Citováno 2016-10-05.
  7. ^ Newby, Greg (08.01.2011). „Zápis ze schůze z 11. prosince 2010“. Distribuované korektory. Citováno 2011-01-08.
  8. ^ „Dokumentace jádra se Sfingou, část 1: jak jsme se sem dostali“. LWN.net. 2016-07-06. Citováno 2016-10-27.
  9. ^ „Poznámky k verzi CMake 3.0.0“. Kitware, Inc. 2014-06-10. Citováno 2016-10-05.

externí odkazy