Skip to main content

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.

News

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.4.tar.gz (770.5 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for hieroglyph-0.4.tar.gz
Algorithm Hash digest
SHA256 a3516bdb1e093813d16f86fa50237734eb1ac9666e913797cf3447cb17747535
MD5 f6ec4821731387a4929efff12f7039a0
BLAKE2b-256 48253794be69fea54d33eb8217d6c117c1bf56a2397743a08f9e8668af1a901e

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

0.7

3 files

0.6.5

1 file

0.6

1 file

0.5.5

1 file

0.5

1 file

This release

0.4 This release

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