This is a work in progress.
It's amazing!
Sections level 1–3 automatically create slide breaks.
There's no way to override this behavior (but we're working on it!).
Add a Sphinx transition (---
) to break a slide:
Slide one
---
Slide two!
You can also disable this feature and use the .. newslide::
directive instead:
Slide one
.. newslide::
Slide two!
Make list items appear one at a time:
.. incr:: nest
- Appears first
- Appears second
- Appears third
If you want nested items to appear at the same time as their parent, use item
:
.. incr:: item
- Appears first
- Appears first too
- Appears second
Or make entire paragraphs appear one at a time:
Initial contents of the slide.
.. incr:: one
Then this paragraph and image will appear!
.. image:: hello.png
Use .. speaker::
to add speaker notes! During the presentation, press s to
open RevealJS's speaker view.
Name of the Sphinx theme to use.
This is not how you override the RevealJS theme. To do that, use
revealjs_theme_options
instead.
Defaults to "revealjs"
.
Use this to set the RevealJS theme.
Defaults to "black"
.
Set to False
, if you don't want slides to break on transitions (---
).
Defaults to True
.
By default, the .. newslide::
directive will copy the title of its parent section. If
you don't want that, set this to False
.
Defaults to True
.
- interslide
- newslide
- speaker
- incremental
Depend on Revealjs (git submodule). See https://git-scm.com/book/en/v2/Git-Tools-Submodules
$ git clone --recurse-submodules <url for this repo>
$ git submodule update --remote lib/revealjs