==========================================
Description of the Beamer Sphinx Extension
==========================================
This extension to `Sphinx <https://www.sphinx-doc.org/en/master/>`__ adds a
`Builder <https://www.sphinx-doc.org/en/master/usage/builders/index.html>`__ for
the `Beamer <https://ctan.org/pkg/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 = <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
.. 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.**
Raw data
{
"_id": null,
"home_page": "https://github.com/ollehu/sphinxcontrib-beamer",
"name": "sphinxcontrib-beamer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Olle Hyn\u00e9n Ulfsj\u00f6\u00f6",
"author_email": "ollehu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/62/b4/c7be98a844bb311b510420f391d629cac7d570e028b1f4c03eef4f475533/sphinxcontrib_beamer-0.0.2.tar.gz",
"platform": null,
"description": "==========================================\nDescription of the Beamer Sphinx Extension\n==========================================\n\nThis extension to `Sphinx <https://www.sphinx-doc.org/en/master/>`__ adds a\n`Builder <https://www.sphinx-doc.org/en/master/usage/builders/index.html>`__ for\nthe `Beamer <https://ctan.org/pkg/beamer>`__ LaTeX class.\n\nInstallation\n============\nThe extension is distributed through the Python Package Index and installed with\n\n.. code-block::\n\n pip install sphinxcontrib-beamer\n\nUsage\n=====\nLoad the extension in the Sphinx project configuration file ``conf.py``::\n\n extensions = ['sphinxcontrib.beamer']\n\nand build your Beamer LaTeX output using the new builder::\n\n sphinx-build -b beamer build/doctrees . build\n\nConfiguration\n-------------\nSome variables are configurable in ``conf.py``:\n\n**Theming:** Change the theme used by Beamer (defaults to ``Warsaw``) with::\n\n beamer_theme = <string>\n\nwhere ``beamertheme<string>.sty`` is a LaTeX style file in the\n``templates_path`` path specified in ``conf.py``.\n\n**Frame breaks:** Change if frame breaks are allowed (defaults to True) with::\n\n beamer_allowframebreaks = <True or False>\n\nwhich sets the ``allowframebreaks`` option to all frames. This Beamer feature\nsplits a frame environment into multiple slides if the content extends beyond\nwhat can be viewed on one slide.\n\n**Custom frame options:** Add custom frame options with\n\n.. code-block::\n\n Frame Title\n -----------\n .. frame_options:plain\n\n Frame content.\n\nwhich will generate a frame environment\n\n.. code-block::\n\n \\begin{frame}[plain]{Frame Title}\n\n Frame content.\n\n \\end{frame}\n\n``plain`` in the example above can be replaced with any comma-separated string\nof valid frame options.\n\n**This extension is still in its beta stage and has not been thorougly tested.\nUse it with caution.**\n",
"bugtrack_url": null,
"license": null,
"summary": "Beamer extension for Sphinx",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/ollehu/sphinxcontrib-beamer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1159bd5fb978e2d582aafe5e669f142b368c8c0fffddd621dd097b4c6f2f14dc",
"md5": "459d12e8bd1cf7e49dcc518a2b89783f",
"sha256": "ef26824ea6583a19ac7f8fadbe0952536ea7960cea518e613437f2fce6f2c58a"
},
"downloads": -1,
"filename": "sphinxcontrib_beamer-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "459d12e8bd1cf7e49dcc518a2b89783f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6890,
"upload_time": "2024-08-06T12:20:34",
"upload_time_iso_8601": "2024-08-06T12:20:34.845691Z",
"url": "https://files.pythonhosted.org/packages/11/59/bd5fb978e2d582aafe5e669f142b368c8c0fffddd621dd097b4c6f2f14dc/sphinxcontrib_beamer-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "62b4c7be98a844bb311b510420f391d629cac7d570e028b1f4c03eef4f475533",
"md5": "339cb708a1b9eebaf6bf8758d1536a1e",
"sha256": "edf79b1b5240f9ed17a3923dce0bd39974682afd126248434aab395edad4f643"
},
"downloads": -1,
"filename": "sphinxcontrib_beamer-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "339cb708a1b9eebaf6bf8758d1536a1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6085,
"upload_time": "2024-08-06T12:20:36",
"upload_time_iso_8601": "2024-08-06T12:20:36.402013Z",
"url": "https://files.pythonhosted.org/packages/62/b4/c7be98a844bb311b510420f391d629cac7d570e028b1f4c03eef4f475533/sphinxcontrib_beamer-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 12:20:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ollehu",
"github_project": "sphinxcontrib-beamer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sphinxcontrib-beamer"
}
JSON
