reStructuredText

reStructuredText (скорочено RST, ReST, або reST) формат файлу для текстових даних, який використовують переважно в середовищі мови програмування Python для створення технічної документації.

reStructuredText
Розширення файлу: ..rst
MIME-тип: text/x-rst[1]
Розробник: David Goodger
Рік випуску: 2 квітня 2002 (2002-04-02)
Остання версія: Revision 7942
Дата випуску останньої версії: 25 травня 2016 (2016-05-25)
Сайт: docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

Він є частиною проекту Docutils групи Python Doc-SIG (Documentation Special Interest Group), що має на меті створити набір інструментів для Python, який був би подібним до Javadoc для Java або POD для Perl. Docutils може діставати інформацію із коментарів програм написаних мовою Python, і перетворювати її у різні форми програмної документації.[2]

В даному сенсі, reStructuredText це спрощена мова розмітки створена для:

  • обробки за допомогою програмних продуктів, наприклад, Docutils,
  • легкого сприйняття тими, хто здатен читати програмний код мовою Python.

Історія

Setext (розроблений Ian Feldman або Tony Sanders) і StructuredText (розроблений Zope) були попередніми формами спрощеної мови розмітки.

Існує ряд проблем пов'язаних із StructuredText, і reST створювався аби усунути їх.[3] Назву reStructuredText було вибрано, щоб підкреслити, що reST — це "revised, reworked, and reinterpreted StructuredText" (переглянутий, перероблений та переосмислений StructuredText).[4]

reST почав активно використовуватись спільнотою Python з 2002 року.

Distributed Proofreaders, який готує тексти для Проекту «Гутенберг», розглядає reST як загальноприйнятий базовий формат для формування усіх інших форматів електронних книг.[5]

Trac також має підтримку мови reStructuredText,[6] так само як і GitHub та Bitbucket.

Реалізації

Реалізація парсеру reST є компонентом фреймворку для обробки тексту Docutils для Мови програмування Python, але також існують інші реалізації парсеру.

Застосування

reStructuredText використовується дя створення технічної документації, наприклад, в документації бібліотек Python.[7] Проте, він підходить для широкого формату текстів.

Із 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.: Іменовані посиланні і анонімні посилання беруться в зворотні лапки (`), а не виділяються апострофами (').

Примітки
  1. 2.23 What's the official MIME type for reStructuredText data? // Docutils FAQ (Frequently Asked Questions)
  2. Mertz, David (1 лютого 2003). XML Matters: reStructuredText. IBM developerWorks. Процитовано 5 жовтня 2016.
  3. Goodger, David (24 травня 2016). reStructuredText: Markup Syntax and Parser Component of Docutils. Docutils Project. Процитовано 5 жовтня 2016.
  4. Goodger, David (26 лютого 2016). Docutils FAQ (Frequently Asked Questions). Docutils Project. Процитовано 5 жовтня 2016.
  5. Newby, Greg (8 січня 2011). Minutes of 2010 December 11 meeting. Distributed Proofreaders. Процитовано 8 січня 2011.
  6. reStructuredText Support in Trac. Trac. 13 вересня 2016. Процитовано 5 жовтня 2016.
  7. Goodger, David (2 квітня 2002). PEP 287 -- reStructuredText Docstring Format. Python Software Foundation. Процитовано 5 жовтня 2016.

Посилання


This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.