ReStructuredText

reStructuredText
Desarrollador
David Goodger
https://docutils.sourceforge.io/rst.html
Información general
Extensión de archivo rst
Tipo de MIME text/x-rst y text/prs.fallenstein.rst
Última versión Revision 7629
11 de marzo de 2013
Tipo de formato documentación técnica
Formato abierto ?

El proyecto 'ReStructured Text es un lenguaje de marcas ligero creado para escribir textos con formato definido de manera cómoda y rápida. Es parte del proyecto Docutils dentro de la comunidad de Python, y es formalizado por el grupo Python Doc-SIG (Documentation Special Interest Group). Tiene la principal ventaja de que ese texto puede usarse para generar documentos equivalentes en HTML, LaTeX, docbook, etc. Es una evolución de Structured Text.

A menudo, el término Restructured Text es abreviada a ReST o reST, causando confusión con el término REST (Representational State Transfer), un tipo de interfaz a través de protocolo HTTP que no tiene relación con el formato que nos ocupa en este artículo.

Ejemplos de sintaxis

Lo que sigue no es un listado exhaustivo de la sintaxis de reST. Véase una referencia más completa de la referencia rápida de rst para obtener más información.

Encabezamientos:

Encabezamiento de sección
=========================

Encabezamiento de subsección
-----------------------------

Listas:

- Un elemento en una lista no ordenada

- Otro elemento en una lista

  - Un sub-elemento

- Tercer elemento
1) Un elemento de una lista numerada

2) Segundo elemento

   a) Sub-elemento

      i) Sub-sub-elemento

3) Tercer elemento
# Otro elemento de una lista enumerada

# Segundo elemento

Enlaces nombrados:

Una oración que enlaza a Wikipedia_ y al `Linux kernel archive`_.

.. _Wikipedia: http://www.wikipedia.org/
.. _Linux kernel archive: http://www.kernel.org/

Enlaces anónimos:

Otra oración con un `enlace anónimo al sitio de Python`__.

__ http://www.python.org/

Enlaces embebidos:

`Python <http://www.python.org/>`_ (enlace roto disponible en Internet Archive; véase el historial, la primera versión y la última)..

Nótese que los enlaces encierran textos con el acento grave (`), y no apóstrofo ('). Si su teclado no tiene la tecla de acento grave; en Microsoft Windows puede digitar el número en el teclado numérico con la combinación Alt+96, en GNU/Linux utilice MAYÚS+CTRL+U y a continuación teclee 6,0 y ESPACIO.

Imágenes:

 .. image:: images/ball1.gif

Enlaces externos

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.