Markdown2ANYMarkdown2ANY
Aprende más

Seleccionar idioma

Elige tu idioma preferido

reStructuredText para documentación de Python

Convierte Markdown a RST para proyectos Sphinx y Python

Convertir a RST

reStructuredText (RST) es el formato de documentación estándar para proyectos Python que usan Sphinx. Aunque Markdown es excelente para escribir, RST ofrece funciones potentes para documentación técnica. Al convertir Markdown a RST, puedes escribir rápidamente en Markdown e integrarte con flujos de trabajo de documentación Python existentes.

¿Por qué convertir a RST?

  • Compatibilidad con Sphinx - RST es el formato nativo de Sphinx
  • Ecosistema Python - La mayoría de la documentación de Python usa RST
  • Referencias cruzadas - RST admite enlaces robustos entre documentos
  • Extensiones - Acceso al potente ecosistema de extensiones de Sphinx
  • Read the Docs - Integración directa con el alojamiento RTD

Cómo funciona

Cuando conviertes Markdown a RST, obtienes la sintaxis RST adecuada:

Introducción
============

Este es un párrafo con texto en **negrita** y *cursiva*.

* Primer elemento
* Segundo elemento

Ejemplo de código
-----------------

.. code-block:: python

   def greet(name):
       return f"Hello, {name}!"
Convertir a RST

Correspondencia de Markdown a RST

MarkdownSalida RST
# EncabezadoSubrayado con =====
## SubencabezadoSubrayado con -----
**negrita****negrita**
*cursiva**cursiva*
`código```código``
[texto](url)`texto <url>`_
Bloques de código.. code-block::

Usar RST con Sphinx

Flujo de trabajo básico

  1. Escribe contenido en Markdown por velocidad
  2. Convierte a RST usando Markdown2ANY
  3. Agrega funciones específicas de RST (directivas, referencias cruzadas)
  4. Compila con Sphinx: sphinx-build -b html source/ build/

Agregar funciones RST

Después de la conversión, mejora tu RST con directivas de Sphinx:

.. note::
   Esta es una nota informativa.

.. warning::
   Esta es una advertencia.

.. seealso::
   :doc:`other-document`

Casos de uso comunes

Documentación de APIs

Convierte archivos README y guías a RST para integrar con referencias de API generadas por autodoc.

Tutoriales

Escribe tutoriales en Markdown, convierte a RST, luego agrega referencias cruzadas a la documentación de APIs.

Guías de contribución

Crea documentación para contribuidores que coincida con el formato del resto de la documentación de tu proyecto.

Funciones específicas de RST

Después de la conversión, puedes agregar funciones RST que Markdown no admite:

  • Admoniciones - Cajas de nota, advertencia, consejo, peligro
  • Referencias cruzadas - Enlaza entre documentos y secciones
  • Roles - Marcado semántico como :func:, :class:
  • Directivas - Bloques de contenido personalizados
  • Toctrees - Jerarquías de documentos

Guías relacionadas

Convertir a RST ahora
reStructuredText para documentación de Python | Markdown2ANY | Markdown2ANY