Skip to main content

A docutils writer and script for converting restructured text to the Beamer presentation format

Project description


A docutils script converting restructured text into Beamer-flavoured LaTeX.

Beamer is a LaTeX document class for presentations. rst2beamer [1] provides a Docutils [3] writer that transforms restructured text [4] into Beamer-flavoured LaTeX. and provides a commandline script for the same. Via this script, ReST can therefore be used to prepare slides and presentations.


rst2beamer can be installed via setuptools / easy_install or manually. Consult the enclosed manual for further details.


Depending on your platform, the scripts may be installed as ``.py`` scripts, or some form of executable, or both.

rst2beamer is called:

rst2beamer [options] [<source> [<destination>]]

For example:

rst2beamer infile.txt outfile.tex

where infile.txt contains the ReST and outfile.tex contains the produced Beamer LaTeX.

It supports the usual docutils and LaTeX writer (rst2latex) options, save the documentclass option (which is fixed to beamer) and hyperref options (which are already set in beamer). It also supports:


Specify Beamer theme.


Overlay bulleted items. Put [<+-| alert@+>] at the end of begin{itemize} so that Beamer creats an overlay for each bulleted item and the presentation reveals one bullet at a time


Center figures. All includegraphics statements will be put inside center environments.


Specify document options. Multiple options can be given, separated by commas. Default is “10pt,a4paper”.


Print embedded notes along with the slides. Possible arguments include ‘false’ (don’t show), ‘only’ (show only notes), ‘left’, ‘right’, ‘top’, ‘bottom’ (show in relation to the annotated slide).

rst2beamer should interpret a reasonable subset of restructured text and produce reasonable LaTeX. Not all features of beamer have been implemented, just a (large) subset that allows the quick production of good looking slides. These include:

  • Overlay lists (i.e. those that appear point-by-point)

  • Beamer themes

  • Automatic centering and resizing of figures

  • Embedded notes and the output of note slides.

  • Arranging slide contents into columns.

Some examples can be found in the docs/examples directory of the distribution. In practice, rst2beamer can be used with pdflatex to get PDF versions of a presentation.


Earlier versions of rst2beamer did not work with docutils 0.4, seemingly due to changes in the LaTeX writer. While this has been fixed, most work has been done with docutils snapshots from version 0.5 and up. In balance, users are recommended to update docutils.

Not all features of beamer are supported, and some - that deal with with page layout or presentation - may never be. Introducing complex syntax to achieve complex and specific page effects defeats the point of ReST’s simple and easy-to-write format. If you need a complex presentation, use Powerpoint or Keynote.

If the content for an individual slide is too large, it will simply overflow the edges of the slide and disappear. Arguably, this is a sign you should put less on each slide.


rst2beamer is developed by Ryan Krauss and Paul-Michael Agapow. Thanks to Dale Hathaway for helping track down the docutils 0.4 bug. Thanks to James Haggerty for detecting and reporting packaging problems.



v0.6.1, 2009-09-14

  • Added note environment

  • Added manual

v0.6, 2009-09-03

  • Introduced column environment

v0.5.3, 2009-07-16

  • Fixed manifest so source included (facepalm)

  • Changed to get single-file module to install

v0.5.1, 2009-05-08

  • Expanded documentation.

v0.5, 2009-05-07

  • Shift to setuptools distribution with script installation.

v0.3, 2009-03-25

  • RK takes over. Sections and subsections are supported. Images default to being centered and having a height of 0.7textheight.

v0.2.1, 2008-08-30

  • Date approximate. Earlier versions of rst2beamer did not work with docutils 0.4, seemingly due to changes in the LaTeX writer.

v0.2.0, 2007-08-30

  • Date approximate. Initial release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rst2beamer-0.6.1.tar.gz (174.3 kB view hashes)

Uploaded Source

Built Distribution

rst2beamer-0.6.1-py2.5.egg (21.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page