https://github.com/ollehu/sphinxcontrib-beamer
Sphinx extension for building Beamer (LaTeX) presentations.
https://github.com/ollehu/sphinxcontrib-beamer
beamer latex sphinx sphinx-extension sphinx-plugin sphinxcontrib
Last synced: over 1 year ago
JSON representation
Sphinx extension for building Beamer (LaTeX) presentations.
- Host: GitHub
- URL: https://github.com/ollehu/sphinxcontrib-beamer
- Owner: ollehu
- License: mit
- Created: 2019-11-14T14:40:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T12:15:11.000Z (almost 2 years ago)
- Last Synced: 2025-02-15T05:47:21.790Z (over 1 year ago)
- Topics: beamer, latex, sphinx, sphinx-extension, sphinx-plugin, sphinxcontrib
- Language: Python
- Homepage:
- Size: 191 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==========================================
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
.. code-block::
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 =
where ``beamertheme.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 =
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
.. code-block::
Frame Title
-----------
.. frame_options:plain
Frame content.
which will generate a frame environment
.. code-block::
\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.**