HTML5 slide generation for Sphinx projects
JavaScript CSS Python
Pull request Compare This branch is 266 commits behind nyergler:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src/hieroglyph
.gitignore
LICENSE
MANIFEST.in
NEWS.txt
README.rst
bootstrap.py
buildout.cfg
setup.cfg
setup.py

README.rst

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 slides 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 originally based on HTML 5 Slides licensed under the Apache Public License.