Generate HTML presentations from plain text sources with all the power of Sphinx.
JavaScript CSS Python HTML Ruby
Latest commit 7504529 Dec 26, 2015 @nyergler Merge pull request #111 from xuhdev/print
Fix an invalid print syntax in Python 3

README.rst

Hieroglyph

https://api.travis-ci.org/nyergler/hieroglyph.png?branch=master https://coveralls.io/repos/nyergler/hieroglyph/badge.png?branch=master

Hieroglyph is an extension for Sphinx which builds HTML presentations from ReStructured Text documents.

Installing

You can install Hieroglyph using easy_install or pip:

$ pip install hieroglyph

You can also install the latest development version, which may contain new features:

$ pip install git+https://github.com/nyergler/hieroglyph#egg=hieroglyph

Hieroglyph supports Sphinx 1.2 and later, and Python 2.7, 3.3, and 3.4.

Using Hieroglyph

You can start a new Hieroglyph presentation using the included quickstart script:

$ hieroglyph-quickstart

This will generate the Sphinx configuration, along with an optional Makefile and batch file, with Hieroglyph enabled.

If you're on something UNIX-like (Linux, Mac OS X, etc), you can then generate your slides by running make:

$ make slides

You can also add Hieroglyph as a Sphinx extension to your existing configuration:

extensions = [
    'hieroglyph',
]

Read the documentation for all the details about using, configuring, and extending Hieroglyph.

Connect

You can connect with other Hieroglyph users and the developers via the hieroglyph-users email list (Google Groups). A Gmane archive is also available.

License

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

Included slide CSS and JavaScript originally based on HTML 5 Slides and io-2012-slides projects licensed under the Apache Public License.