Skip to main content

Beamer extension for Sphinx

Project description

This extension to Sphinx adds a Builder for the Beamer LaTeX class.


The extension is distributed through the Python Package Index and installed with

pip install sphinxcontrib-beamer


Load the extension in the Sphinx project configuration file

extensions = ['sphinxcontrib.beamer']

and build your Beamer LaTeX output using the new builder:

sphinx-build -b beamer build/doctrees . build


Some variables are configurable in

Theming: Change the theme used by Beamer (defaults to Warsaw) with:

beamer_theme = <string>

where beamertheme<string>.sty is a LaTeX style file in the templates_path path specified in

Frame breaks: Change if frame breaks are allowed (defaults to True) with:

beamer_allowframebreaks = <True or False>

which sets the allowframebreaks option to all frames. This Beamer feature splits a frame environment into multiple slides if the content extends beyond what can be viewed on one slide.

Custom frame options: Add custom frame options with

Frame Title
.. frame_options:plain

Frame content.

which will generate a frame environment

\begin{frame}[plain]{Frame Title}

   Frame content.


plain in the example above can be replaced with any comma-separated string of valid frame options.

This extension is still in its beta stage and has not been thorougly tested. Use it with caution.

Project details

Download files

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

Files for sphinxcontrib-beamer, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_beamer-0.0.1-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxcontrib-beamer-0.0.1.tar.gz (5.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page