Hieroglyph is an extension for Sphinx which builds HTML
presentations from ReStructured Text documents.
You can install Hieroglyph using
$ easy_install hieroglyph
You can also download the latest development version, which may
contain new features. Hieroglyph supports Sphinx 1.2 and later, and
Python 2.7, 3.3, and 3.4.
You can start a new Hieroglyph presentation using the included
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
You can also add Hieroglyph as a Sphinx extension to your
extensions = [
Read the documentation for all the details about using,
configuring, and extending Hieroglyph.
You can connect with other Hieroglyph users and the developers via the
hieroglyph-users email list (Google Groups). A Gmane archive is
Hieroglyph is made available under a BSD license; see LICENSE for
and io-2012-slides projects licensed under the Apache Public
Release date: 28 March 2015
- Add title-iamge slide class
- Bug fix: slides2 theme includes extra slides (#92)
- Bug fix: entry point invocation relies on new setuptools (#94)
- Bug fix: RST quotes raise exceptions (#93)
Release date: 16 March 2015
- Themes now use a template fragment for rendering individual slides.
- Bug fix: files in
html_static_dir will now override theme files.
slide_title configuration setting. (Issue #56)
slides2 theme, based on updated Google HTML 5 slide
templates. (Issue #48)
- Added more flexible incremental slides using build-item-* classes.
- Theme creation documentation (#53)
- Section slide CSS updated for printing. (Issue #37)
- Handle titles with embedded markup w/ nextslide directive. (#85)
- Improved quickstart script
Release date: 1 March 2014
document." This caused issues with content in ifnotslides blocks.
- Fixed an issue with path mangling for generated images (ie, from
- Added support for
slide_footer (Issue #44)
- Converted slide condition directive processing to use Docutils
transforms. This allows section headings to appear in tables of
contents correctly. (Issue #25)
nextslide directive for splitting sections.
- Section classes are now added to the generated slides (Issue #50).
Release date: 8 August 2013
note directive in a slide now shows up as notes in the
presenter console. Thanks, Doug Hellmann!
- slides.js now fires an event when the slides are resized.
- Support setting default classes on slides in a document.
fade-in slide classes for alternate
- Added testing framework, initial tests for directives
- Fixed bug where content was not removed with autoslides was
- Slides created with the slide directive may omit have only a title,
or only content (Issue #30)
- Slide numbering was often incorrect when dealing with multiple slide
levels; this has been correct (Issue #26)
- Better page break handling when printing slides (PR #31). Thanks,
Release date: 19 March 2013
- Rewrote, updated, and expanded documentation, including the addition
of the Getting Started guide.
inline-contents option to the
- Fixed bug with image path calculation for documents in nested trees.
This primarily impacted images generated by other extensions, such
- Added support for marking a section as a slide when autoslides are
- All slide-related nodes are now left intact when pruning the tree.
- Fixed bug related to changing themes between documents that resulted
in Sphinx reporting Template Not Found.
- Fixed level calculation for slides created with the
- Simplified processing of
slideconf nodes: previously an attempt
was made to remove them when not building slides. This was fragile,
and led to breakage in the latex and texinfo builders. They're now
skipped properly for all builtin Sphinx builders.
Release date: 24 December 2012
- Added support for
autoslides config parameter to allow disabling automatic
generation of slides from document text.
- Added inline slide builder.
notslides directives to
ifnotslides, respectively. The old names will continue to work
for a while, the rename just makes them more expressive.
- Changed key for toggling slide table view to
- Fixed problems with styling nested lists
- Fixed incompatibility with latex-pdf builder
Release date: 27 September 2012
- Print-specific styling for printing slides
- More accurate display of scaled slides on Slide Table
- Initial implementation of Presenter Console
- Themes and docs include font files locally
- Changed interlink configuration keys to be more consistent.
- Support for file-specific theme configuration
- Support for slide numbering
Release date: 5 June 2012
- Correctly generate relative links between HTML & Slides
Release date: 5 June 2012
- Added content, code missing from the 0.3 release.
- Updated README to reflect changes in 0.3.
- Changed docs configuration to build HTML + Slides.
Backward Incompatible Changes:
Release date: 4 June 2012
- Provide directory and standalone based builders.
- Fix up absolute image paths from things like blockdiag
- Preliminary support for linking between HTML to Slides
- Preliminary slide table support
- Builders have been renamed to
dirslides. If your
Makefile refers to
will need to update it.
Release date: 10 March 2012
- Initial implementation of Sphinx builder.
- Two themes: slides and single-level
- Basic documentation