Generate HTML presentations from plain text sources with all the power of Sphinx.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src Move to versioneer for version management. Sep 7, 2017
.gitattributes
.gitignore
.travis.yml
Gemfile Execute Jasmine tests as part of the Travis build (#61). Mar 29, 2014
LICENSE
MANIFEST.in
NEWS.txt Preparing for 1.0 release Sep 7, 2017
README.rst Preparing for 1.0 release Sep 7, 2017
Rakefile Execute Jasmine tests as part of the Travis build (#61). Mar 29, 2014
setup.cfg
setup.py
tox.ini Build test docs as part of CI. Sep 7, 2017
versioneer.py

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.4 and later, and Python 2.7 and 3.6.

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.