Skip to content

ramnathv/hieroglyph

 
 

Repository files navigation

hieroglyph

hieroglyph is an extension for Sphinx which builds HTML5 slides from ReStructured Text documents.

Installing

You can install hieroglyph using easy_install or pip:

$ easy_install hieroglyph

You can also download the latest development version, which may contain new features.

Using Hieroglyph

Add hieroglyph as a Sphinx extension to your configuration:

extensions = [
    'hieroglyph',
]

Build your slides:

$ sphinx-build -b html5slides sourcedir outdir

Where sourcedir is the directory containing the sphinx conf.py file and outdir is where you want your slides to output to.

License

hieroglyph is made available under a BSD license; see LICENSE for details.

Included slide CSS and javascript licensed under the Apache Public License. See http://code.google.com/p/html5slides/.

About

HTML5 slide generation for Sphinx projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published