Skip to main content

Sphinx extension with theme to generate Reveal.js presentation

Project description

https://img.shields.io/pypi/v/sphinx-revealjs.svg https://github.com/attakei/sphinx-revealjs/workflows/Testings/badge.svg https://travis-ci.org/attakei/sphinx-revealjs.svg?branch=master

Sphinx extention with theme to generate 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

$ pip install 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
    

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.

Futures

  • Index template as none presentation
  • CDN support

Contributings

GitHub repository does not have reveal.js library.

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

$ git clone https://github.com/attakei/sphinx-revealjs
$ cd sphinx-revealjs
$ poetry install
$ poetry run python tools/fetch_revealjs.py

Project details


Download files

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

Files for sphinx-revealjs, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_revealjs-1.0.0-py3-none-any.whl (2.1 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-revealjs-1.0.0.tar.gz (2.1 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page