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 Documentation Status

Sphinx extension with theme to generate Reveal.js presentation

Overview

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.

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.

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

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

Uploaded source

Built Distribution

sphinx_revealjs-2.0.1-py3-none-any.whl (2.5 MB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page