Docutils

Docutils is a suite of utilities for transforming text files that contain reStructuredText into other formats, including HTML, XML, and LaTeX. It is meant to bridge the gap between what users want to read (aesthetically pleasant formats) and what programmers can easily type (plain text). Docutils falls into two broad categories: libraries (to do behind-the scenes parsing and manipulation) and frontend tools (which use libraries to produce a particular output format).

Installation

Docutils can be installed using pip:

pip install docutils

This will install a number of scripts, including the important transformation scripts. The author's installation is included:

  • rst2html.py
  • rst2latex.py
  • rst2man.py
  • rst2odt_prepstyles.py
  • rst2odt.py
  • rst2pseudoxml.py ...

Get Mastering IPython 4.0 now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.