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 licensed under the Apache Public License. See http://code.google.com/p/html5slides/.

News

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for hieroglyph-0.3.2.tar.gz
Algorithm Hash digest
SHA256 7cacd5fd90305bf08ca44aeefb6c400575591f6aa12dd882a11f19dffed4fbcb
MD5 95ff744e1b13e40e9972f3759d25e2cf
BLAKE2b-256 e1dcfd0342a6a052543b626afe4a0f25742bb9ccaa268574fad3265419642086

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

0.4

1 file

This release

0.3.2 This release

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