Skip to main content
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:

$ 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.

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.

News

0.7

  • Release date: 16 March 2015*

  • Themes now use a template fragment for rendering individual slides. (Issue #49)

  • Bug fix: files in html_static_dir will now override theme files. (Issue #54)

  • Added slide_title configuration setting. (Issue #56)

  • Added 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

0.6.5

Release date: 1 March 2014

  • Revert “Javascript loading is now deferred until the end of the document.” This caused issues with content in ifnotslides blocks. (Issue #33)

  • Fixed an issue with path mangling for generated images (ie, from blockdiag).

  • 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)

  • Added nextslide directive for splitting sections. (Issue #46)

  • Section classes are now added to the generated slides (Issue #50).

0.6

Release date: 8 August 2013

  • The note directive in a slide now shows up as notes in the presenter console. Thanks, Doug Hellmann!

  • Javascript loading is now deferred until the end of the document.

  • Allow projects to specify custom Javascript to be included with slides.

  • slides.js now fires an event when the slides are resized.

  • Support setting default classes on slides in a document.

  • Added appear and fade-in slide classes for alternate transitions.

  • Added hieroglyph-quickstart script.

  • Added testing framework, initial tests for directives

  • Fixed bug where content was not removed with autoslides was disabled

  • 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, tjadevries!

0.5.5

Release date: 19 March 2013

  • Rewrote, updated, and expanded documentation, including the addition of the Getting Started guide.

  • Added inline-contents option to the slide directive.

  • Fixed bug with image path calculation for documents in nested trees. This primarily impacted images generated by other extensions, such as blockdiag.

  • Added support for marking a section as a slide when autoslides are disabled.

  • 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 slide directive.

  • 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.

  • Updated Javascript for incremental slides to work with recent builds of Chrome

0.5

Release date: 24 December 2012

  • Added support for slide directive

  • Added autoslides config parameter to allow disabling automatic generation of slides from document text.

  • Added inline slide builder.

  • Renamed slides and notslides directives to ifslides and 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 t (was ESC).

  • Fixed problems with styling nested lists

  • Fixed incompatibility with latex-pdf builder

0.4

Release date: 27 September 2012

  • Print-specific styling for printing slides

  • Template and javascript clean-up/reorganization

  • 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

0.3.2

Release date: 5 June 2012

  • Correctly generate relative links between HTML & Slides

0.3.1

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.

0.3

Release date: 4 June 2012

  • Provide directory and standalone based builders.

  • Added slides and notslides directives.

  • Fix up absolute image paths from things like blockdiag

  • Preliminary support for linking between HTML to Slides

  • Preliminary slide table support

Backward Incompatible Changes:

  • Builders have been renamed to slides and dirslides. If your Makefile refers to html5slides or dirhtml5slides, you will need to update it.

0.2

Release date: 10 March 2012

  • Initial implementation of Sphinx builder.

  • Two themes: slides and single-level

  • Basic documentation

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hieroglyph-0.7.tar.gz (859.9 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

hieroglyph-0.7-py2.py3-none-any.whl (1.5 MB view details)

Uploaded Python 2Python 3

hieroglyph-0.7-py2.7.egg (1.5 MB view details)

Uploaded Egg

File details

Details for the file hieroglyph-0.7.tar.gz.

File metadata

  • Download URL: hieroglyph-0.7.tar.gz
  • Upload date:
  • Size: 859.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hieroglyph-0.7.tar.gz
Algorithm Hash digest
SHA256 2eb31fa2c854ee5ea6b7a856f80c3e8c1c4085da284682b3e4a0c22e70278333
MD5 d229971df3add0950f9f6cdb66ff5496
BLAKE2b-256 0de00d5d725fa28e3bdddec95cb7526aa6e92b856921295e1bb5cba0018f5a54

See more details on using hashes here.

File details

Details for the file hieroglyph-0.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for hieroglyph-0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 38f14e28bc3f15f6177dfa084e919ec4c9d6e6a3022356583dd7fd5addfe0879
MD5 01c08b335d4468f54a185654343a657e
BLAKE2b-256 468879ef0980c204f52e22b32a971df8974b90dfa26b47fe15bc3e0d270aa8b0

See more details on using hashes here.

File details

Details for the file hieroglyph-0.7-py2.7.egg.

File metadata

  • Download URL: hieroglyph-0.7-py2.7.egg
  • Upload date:
  • Size: 1.5 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hieroglyph-0.7-py2.7.egg
Algorithm Hash digest
SHA256 d7e3b599ceb61dd463042f513e7b1e7a169b9475e7bc1bb059508a236c4d8d14
MD5 b6f571273ad2e3442b23b0766ceab0c0
BLAKE2b-256 0265c86cad9cbb20ef026ab6f14f55a5656e3c67b5af0ee0342c521540265590

See more details on using hashes here.

Release history Release notifications | RSS feed

2.1.0

2 files

2.0.0

2 files

1.0.0

2 files

0.7.1

3 files

This release

0.7 This release

3 files

0.6.5

1 file

0.6

1 file

0.5.5

1 file

0.5

1 file

0.4

1 file

0.3.2

1 file

0.3.1

1 file

0.3

1 file

0.2

1 file

0.1.2

1 file

0.1.1

1 file

0.1

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page