reStructuredText (скорочено RST, ReST, або reST) формат файлу для текстових даних, який використовують переважно в середовищі мови програмування Python для створення технічної документації.
Розширення файлу: | .rst |
---|---|
MIME-тип: | text/x-rst |
Розробник: | David Goodger |
Рік випуску: | 2 квітня 2002 |
Остання версія: | Revision 7942 |
Дата випуску останньої версії: | 25 травня 2016 |
Сайт: | docutils.sourceforge.net/docs/ref/rst/restructuredtext.html |
Він є частиною проекту Docutils групи Python Doc-SIG (Documentation Special Interest Group), що має на меті створити набір інструментів для Python, який був би подібним до Javadoc для Java або для Perl. Docutils може діставати інформацію із коментарів програм написаних мовою Python, і перетворювати її у різні форми програмної документації.
В даному сенсі, reStructuredText це створена для:
- обробки за допомогою програмних продуктів, наприклад, ,
- легкого сприйняття тими, хто здатен читати програмний код мовою Python.
Історія
(розроблений Ian Feldman або Tony Sanders) і StructuredText (розроблений Zope) були попередніми формами спрощеної мови розмітки.
Існує ряд проблем пов'язаних із StructuredText, і reST створювався аби усунути їх. Назву reStructuredText було вибрано, щоб підкреслити, що reST — це "revised, reworked, and reinterpreted StructuredText" (переглянутий, перероблений та переосмислений StructuredText).
reST почав активно використовуватись спільнотою Python з 2002 року.
, який готує тексти для Проекту «Гутенберг», розглядає reST як загальноприйнятий базовий формат для формування усіх інших форматів електронних книг.
Trac також має підтримку мови reStructuredText, так само як і GitHub та Bitbucket.
Реалізації
Реалізація парсеру reST є компонентом фреймворку для обробки тексту Docutils для Мови програмування Python, але також існують інші реалізації парсеру.
Застосування
reStructuredText використовується дя створення технічної документації, наприклад, в документації бібліотек Python. Проте, він підходить для широкого формату текстів.
Із 2008, reST став основним компонентом системи створення документації для мови Python, що називається Sphinx.
Прикладни розмітки reST
Заголовки
Заголовок розділу ============== Підзаголовок розділу -----------------
Списки
- Елемент маркованого списку - Другий пункт - Підпункт - Розділи між пунктами утворюють окремі списки - Третій пункт 1) Нумерований елемент списку 2) Другий елемент a) Вкладений елемент списку, що має велику довжину тому його необхідно розбивати на рядки. Варто відмітити, що відступ повинен відповідати початку тексту, а не енумератору списку. i) Елементи списку також можуть містити абзаци. 3) Третій елемент #) Наступний елемент нумерованого списку #) Другий елемент
Зображення
.. image:: /path/to/image.jpg
Іменовані посилання
Фраза із посиланням на сайт Вікіпедія_ і `Linux kernel archive`_. .. _Вікіпедія: http://www.wikipedia.org/ .. _Linux kernel archive: http://www.kernel.org/
Анонімні посилання
Інша фраза із `anonymous link to the Python website`__. __ https://www.python.org/
N.B.: Іменовані посиланні і анонімні посилання беруться в зворотні лапки (`), а не виділяються апострофами (').
Примітки
- 2.23 What's the official MIME type for reStructuredText data? // Docutils FAQ (Frequently Asked Questions)
- Mertz, David (1 лютого 2003). . . Архів оригіналу за 6 жовтня 2016. Процитовано 5 жовтня 2016.
- Goodger, David (24 травня 2016). . Docutils Project. Архів оригіналу за 5 жовтня 2016. Процитовано 5 жовтня 2016.
- Goodger, David (26 лютого 2016). . Docutils Project. Архів оригіналу за 10 грудня 2017. Процитовано 5 жовтня 2016.
- Newby, Greg (8 січня 2011). Minutes of 2010 December 11 meeting. Distributed Proofreaders. Процитовано 8 січня 2011.
- . Trac. 13 вересня 2016. Архів оригіналу за 6 жовтня 2016. Процитовано 5 жовтня 2016.
- Goodger, David (2 квітня 2002). . Python Software Foundation. Архів оригіналу за 6 жовтня 2016. Процитовано 5 жовтня 2016.
Посилання
- Офіційний вебсайт проекту reStructuredText [ 5 жовтня 2016 у Wayback Machine.]
- Python Enhancement Proposal (PEP) 287: reStructuredText Docstring Format [ 6 жовтня 2016 у Wayback Machine.]
- XML Matters: reStructuredText [ 6 жовтня 2016 у Wayback Machine.]
Це незавершена стаття про мови програмування. Ви можете проєкту, виправивши або дописавши її. |
Вікіпедія, Українська, Україна, книга, книги, бібліотека, стаття, читати, завантажити, безкоштовно, безкоштовно завантажити, mp3, відео, mp4, 3gp, jpg, jpeg, gif, png, малюнок, музика, пісня, фільм, книга, гра, ігри, мобільний, телефон, android, ios, apple, мобільний телефон, samsung, iphone, xiomi, xiaomi, redmi, honor, oppo, nokia, sonya, mi, ПК, web, Інтернет
reStructuredText skorocheno RST ReST abo reST format fajlu dlya tekstovih danih yakij vikoristovuyut perevazhno v seredovishi movi programuvannya Python dlya stvorennya tehnichnoyi dokumentaciyi reStructuredTextRozshirennya fajlu rstMIME tip text x rstRozrobnik David GoodgerRik vipusku 2 kvitnya 2002 22 roki tomu 2002 04 02 Ostannya versiya Revision 7942Data vipusku ostannoyi versiyi 25 travnya 2016 8 rokiv tomu 2016 05 25 Sajt docutils sourceforge net docs ref rst restructuredtext html Vin ye chastinoyu proektu Docutils grupi Python Doc SIG Documentation Special Interest Group sho maye na meti stvoriti nabir instrumentiv dlya Python yakij buv bi podibnim do Javadoc dlya Java abo dlya Perl Docutils mozhe distavati informaciyu iz komentariv program napisanih movoyu Python i peretvoryuvati yiyi u rizni formi programnoyi dokumentaciyi V danomu sensi reStructuredText ce stvorena dlya obrobki za dopomogoyu programnih produktiv napriklad legkogo sprijnyattya timi hto zdaten chitati programnij kod movoyu Python Istoriya rozroblenij Ian Feldman abo Tony Sanders i StructuredText rozroblenij Zope buli poperednimi formami sproshenoyi movi rozmitki Isnuye ryad problem pov yazanih iz StructuredText i reST stvoryuvavsya abi usunuti yih Nazvu reStructuredText bulo vibrano shob pidkresliti sho reST ce revised reworked and reinterpreted StructuredText pereglyanutij pereroblenij ta pereosmislenij StructuredText reST pochav aktivno vikoristovuvatis spilnotoyu Python z 2002 roku yakij gotuye teksti dlya Proektu Gutenberg rozglyadaye reST yak zagalnoprijnyatij bazovij format dlya formuvannya usih inshih formativ elektronnih knig Trac takozh maye pidtrimku movi reStructuredText tak samo yak i GitHub ta Bitbucket RealizaciyiRealizaciya parseru reST ye komponentom frejmvorku dlya obrobki tekstu Docutils dlya Movi programuvannya Python ale takozh isnuyut inshi realizaciyi parseru ZastosuvannyareStructuredText vikoristovuyetsya dya stvorennya tehnichnoyi dokumentaciyi napriklad v dokumentaciyi bibliotek Python Prote vin pidhodit dlya shirokogo formatu tekstiv Iz 2008 reST stav osnovnim komponentom sistemi stvorennya dokumentaciyi dlya movi Python sho nazivayetsya Sphinx Prikladni rozmitki reSTZagolovki Zagolovok rozdilu Pidzagolovok rozdilu Spiski Element markovanogo spisku Drugij punkt Pidpunkt Rozdili mizh punktami utvoryuyut okremi spiski Tretij punkt 1 Numerovanij element spisku 2 Drugij element a Vkladenij element spisku sho maye veliku dovzhinu tomu jogo neobhidno rozbivati na ryadki Varto vidmititi sho vidstup povinen vidpovidati pochatku tekstu a ne enumeratoru spisku i Elementi spisku takozh mozhut mistiti abzaci 3 Tretij element Nastupnij element numerovanogo spisku Drugij element Zobrazhennya image path to image jpg Imenovani posilannya Fraza iz posilannyam na sajt Vikipediya i Linux kernel archive Vikipediya http www wikipedia org Linux kernel archive http www kernel org Anonimni posilannya Insha fraza iz anonymous link to the Python website https www python org N B Imenovani posilanni i anonimni posilannya berutsya v zvorotni lapki a ne vidilyayutsya apostrofami Primitki2 23 What s the official MIME type for reStructuredText data Docutils FAQ Frequently Asked Questions Mertz David 1 lyutogo 2003 Arhiv originalu za 6 zhovtnya 2016 Procitovano 5 zhovtnya 2016 Goodger David 24 travnya 2016 Docutils Project Arhiv originalu za 5 zhovtnya 2016 Procitovano 5 zhovtnya 2016 Goodger David 26 lyutogo 2016 Docutils Project Arhiv originalu za 10 grudnya 2017 Procitovano 5 zhovtnya 2016 Newby Greg 8 sichnya 2011 Minutes of 2010 December 11 meeting Distributed Proofreaders Procitovano 8 sichnya 2011 Trac 13 veresnya 2016 Arhiv originalu za 6 zhovtnya 2016 Procitovano 5 zhovtnya 2016 Goodger David 2 kvitnya 2002 Python Software Foundation Arhiv originalu za 6 zhovtnya 2016 Procitovano 5 zhovtnya 2016 PosilannyaOficijnij vebsajt proektu reStructuredText 5 zhovtnya 2016 u Wayback Machine Python Enhancement Proposal PEP 287 reStructuredText Docstring Format 6 zhovtnya 2016 u Wayback Machine XML Matters reStructuredText 6 zhovtnya 2016 u Wayback Machine Ce nezavershena stattya pro movi programuvannya Vi mozhete dopomogti proyektu vipravivshi abo dopisavshi yiyi