Setup

Requirements

sphinx-revealjs requires Python 3.6+, Sphinx and make.

Latest development environment

  • Python

    • 3.6.x

    • 3.7.x

  • Sphinx

    • 1.8.2

Installation

Because sphinx-revealjs is registered in PyPI, you can install this by pip .

$ 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 have html builder but revealjs builder. To use builder, edit your conf.py.

extensions = [
    'sphinx_revealjs',
]

if you want to configure more, edit conf.py with seeing settings page.

Build

Run make command to build presentations. Files are generated to revealjs folder.

$ make revealjs