Skip to main content

Sphinx extension with theme to generate Reveal.js presentation

Project description Documentation Status

Sphinx extension with theme to generate Reveal.js presentation


This extension generate Reveal.js presentation from standard reStructuredText.

It include theses features.

  • Custom builder to translate from reST to reveal.js style HTML

  • Template to be enable to render presentation local independent

For more information, refer to the documentation.


$ pip install sphinx-revealjs


  1. Create your sphinx documentation

  2. Edit to use this extension

    extensions = [
  3. Write source for standard document style

  4. Build sources as Reveal.js presentation

    $ make revealjs

Change logs

See it

Policy for following to Reveal.js version

This is implemented based Reveal.js. I plan to update it at patch-version for catch up when new Reveal.js version released.

  • If Reveal.js updated minor or patch version, sphinx-revealjs update patch version.

  • If Reveal.js updated major version, sphinx-revealjs update minor version with compatible for two versions.


GitHub repository does not have reveal.js library.

If you use from GitHub and editable mode, Run tools/ after install.

$ git clone
$ cd sphinx-revealjs
$ python tools/

For more information, See CONTRIBUTING.rst and “contributing” page in documentation.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_revealjs-2.9.2.tar.gz (2.4 MB view hashes)

Uploaded source

Built Distribution

sphinx_revealjs-2.9.2-py2.py3-none-any.whl (2.4 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page