Setup ¶
Requirements ¶
sphinx-revealjs
requires Python 3.7+ and Sphinx 4.0+.
Current development environment ¶
-
Python:
3.11.x
-
Sphinx:
5.3.0
Installation ¶
You can install
sphinx-revealjs
from PyPI.
$ pip install sphinx-revealjs
sphinx-revealjs
specify
Sphinx
and
docutils
expressly as dependencies.
You get
Sphinx
by this command only.
Configuration ¶
sphinx-revealjs
does not provide
revealjs
builder instead of
html
builder.
To use builder, edit your
conf.py
.
extensions = [
"sphinx_revealjs",
]
if you want to configure more, edit conf.py with seeing Configurations .
Build ¶
Run
make
command to build presentations.
Files are generated to
revealjs
folder.
$ make revealjs
You can generate all pages as
index.html
to use
dirrevealjs
.
make dirrevealjs