2009-07-28 16 views
14

Planeo usar reStructuredText para escribir documentación con el propósito principal de generar algunas páginas HTML agradables. Para esto uso la herramienta docutils rst2html.py.Cómo convertir reStructuredText a texto sin formato

Sin embargo, también es posible que deba presentar la documentación en un formato de texto plano, sin el reStructuredText, y donde el ajuste de párrafo y el formato agradable similar aún se realiza en el texto. Pero no hay una herramienta rst2txt.py en los docutils.

¿Hay alguna manera de convertir reStructuredText al formato de texto plano, quizás con el uso de opciones especiales para docutils?

+3

Creo que reStructuredText es ese "buen formato de texto plano" que está buscando en primer lugar! –

Respuesta

9

Sphinx tiene un TextBuilder para formato de salida de texto. Lo intenté y parece hacer lo que está buscando.

Sin embargo, podría estar un poco desactualizado porque no está en el Makefile predeterminado. Pero funcionó bien en mi documentación bastante compleja (150 páginas en PDF). Para usarlo, basta con añadir el siguiente objetivo a ella:

text: 
    $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text 
    @echo 
    @echo "Build finished." 

Además, tenga en cuenta que Sphinx implementa sólo un subconjunto de las primeras especificaciones.

+0

Gracias a Thoriann, pude hacer que esto funcionara a través del archivo MAKE. También me gustaría utilizar el TextBuilder directamente desde Python, pero no pude encontrar ninguna documentación para esto. ¿Sabes dónde encontrar documentación para la clase TextBuilder o un breve ejemplo que muestra cómo usarla desde Python? Saludos cordiales, Morten –

+0

No conozco ninguna documentación sobre esto, tampoco. Puede buscar en cmdline.py del código fuente de Sphinx para ver un ejemplo. Parece factible, si realmente quieres eso. – tsg

+0

Hola Thoriann, gracias por tu respuesta. Ten un buen fin de semana. Saludos, Morten –

11

También he visto este hecho por la representación de HTML usando rst2html, a continuación, convertir el HTML a texto sin formato mediante el uso de un navegador HTML de línea de comandos, tales como:

Cada uno de estos navegadores tiene un modificador de línea de comandos o similares para hacer su salida a un archivo .txt, por lo que podría crear un guión de dos líneas llamada 'rst2txt', algo así como:

rst2html docs.rst docs.html 
lynx -dump docs.html > docs.txt 
+0

Este funcionó mejor para mí. Creo que lo 'correcto' es escribir una hoja de estilo XLST para convertir a txt y quizás org-mode – JeffG

0

El texto en línea NoTex.ch editor (con soporte para rST) incluye soporte para conversión de texto sin formato (que está basado en Sphinx 'TextBuilder).

Cuestiones relacionadas