Metadata-Version: 2.1
Name: sphinx-revealjs
Version: 0.4.0
Summary: Sphinx extention with theme to generate Reveal.js presentation
Home-page: https://github.com/attakei/sphinx-revealjs
Author: attakei
Author-email: attakei@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Requires-Dist: docutils
Requires-Dist: Sphinx
Provides-Extra: testing
Requires-Dist: nose; extra == 'testing'
Requires-Dist: sphinx-testing; extra == 'testing'

sphinx-revealjs
===============

.. image:: https://img.shields.io/pypi/v/nine.svg
    :target: https://pypi.org/project/sphinx-revealjs/

.. image:: https://travis-ci.org/attakei/sphinx-revealjs.svg?branch=master
    :target: https://travis-ci.org/attakei/sphinx-revealjs


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

.. code-block:: bash

    $ pip install sphinx-revealjs


Usage
-----

1. Create your sphinx documentation
2. Edit `conf.py` to use this extension

    .. code-block:: python

        extensions = [
            'sphinx_revealjs',
        ]

3. Write source for standard document style

4. Build sources as Reveal.js presentation

    .. code-block:: bash

        $ make revealjs

Change logs
-----------

See `it <./CHANGES.rst>`_

Futures
-------

* Index template as none presentation
* CDN support


