Skip to main content

Description of the Beamer Sphinx Extension

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

Installation

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

pip install sphinxcontrib-beamer

Usage

Load the extension in the Sphinx project configuration file conf.py:

extensions = ['sphinxcontrib.beamer']

and build your Beamer LaTeX output using the new builder:

sphinx-build -b beamer build/doctrees . build

Configuration

Some variables are configurable in conf.py:

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 conf.py.

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.

\end{frame}

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.

Metadata

Release files for sphinxcontrib-beamer 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-beamer 0.0.2
File Size Uploaded
sphinxcontrib_beamer-0.0.2.tar.gz 6.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-beamer 0.0.2
File Interpreter ABI Platform
sphinxcontrib_beamer-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 13.0 kB

Release files / sphinxcontrib_beamer-0.0.2.tar.gz

Download URL sphinxcontrib_beamer-0.0.2.tar.gz
Size 6.1 kB
Tags Source
SHA-256 checksum
How to use checksums
edf79b1b5240f9ed17a3923dce0bd39974682afd126248434aab395edad4f643
BLAKE2b-256 checksum
How to use checksums
62b4c7be98a844bb311b510420f391d629cac7d570e028b1f4c03eef4f475533
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release files / sphinxcontrib_beamer-0.0.2-py3-none-any.whl

Download URL sphinxcontrib_beamer-0.0.2-py3-none-any.whl
Size 6.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ef26824ea6583a19ac7f8fadbe0952536ea7960cea518e613437f2fce6f2c58a
BLAKE2b-256 checksum
How to use checksums
1159bd5fb978e2d582aafe5e669f142b368c8c0fffddd621dd097b4c6f2f14dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page