Skip to main content

Sphinx extention with theme to generate Reveal.js presentation

Project description

Sphinx extention for generating Reveal.js presentation.

Orverview

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 imdependent

Installation

This project is not registered to PyPI.

For installation, you need to install from GitHub.

$ pip install git+https://github.com/attakei/sphinx-revealjs

Usage

  1. Create your sphinx documentation

  2. Edit conf.py to use this extension

    extensions = [
        'sphinx_revealjs',
    ]
  3. Write source for standard document style

  4. Build sources as Reveal.js presentation

    $ make revealjs

Futures

  • Index template as none presentation

  • Theme select per presentations

  • CDN support

Project details


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-0.3.1.tar.gz (1.6 MB view hashes)

Uploaded Source

Built Distribution

sphinx_revealjs-0.3.1-py3-none-any.whl (3.2 MB view hashes)

Uploaded Python 3

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