docutils y rst2pdf

Utilidades para la documentación

Gracias a estas herramientas podemos generar documentación en forma simple, escribiendo texto en nuestro editor favorito.

La sintáxis es simple y está mejor explicada en los enlaces citados al pie. Pero veamosla un poco:

.. -*- coding: utf-8 -*-

Título general
==============

.. |date| date:: %Y-%m-%d %H:%M
.. |version| date:: %Y%m%d

:Author: Nombre Apellido
:Contact: usuario@dominio.com
:Version: |version|.01
:Date: |date|
:Copyright: Este documento es de dominio público

.. contents:: Contenidos

Subtítulo 1
-----------

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Subtítulo 2
-----------

* Item 1 de lista
* Item 2 de lista
* Item 3 de lista

Subtítulo 2
-----------

* Item 1 de lista
* Item 2 de lista
* Item 3 de lista

Subsubtítulo
''''''''''''
.. code-block:: pascal

  Procedure apilar(var P:TPila, ele:TipoBase);
  begin
    P.tope := P.tope + 1;
    P.elementos[P.tope] := ele;
  end;

Todo esto generará un documento con un título, un índice con los enlaces a las páginas de los subtítulos y a los subsubtítulos, y también coloreo de sintáxis, en este caso para Pascal. Hay coloreo para varios lenguajes, para todos los que sporte pygments.

También hay que prestarle atención a un rst2html mejorado con coloreo de sintáxis.

Mucha mas información en:

Publicado: 20/04/2011
Etiquetas: docutils, rst, pdf, python