Advanced Usage§

The slide directive§

Instead of (or in addition to) section headings, Hieroglyph also includes a directive that may be used to indicate a Slide should be created. The directive may have a title specified, as well as a level parameter.

For example:

.. slide:: The Slide Title
   :level: 2

   This Slide would appear as a level two slide.

Interlinking HTML Output§

Hieroglyph supports linking between slides and HTML output, such as from the Sphinx HTML builders. In order to do this successfully, the slide and HTML builders used must correspond to one another. That is, the SlideBuilder must be used with the StandaloneHTMLBuilder, and the DirectorySlideBuilder must be used with the DirectoryHTMLBuilder.

For example, runnning:

$ make html slides

Will generate HTML and slides if interlinking is enabled. See Interlinking HTML Output for information on enabling interlinking in the configuration.

Custom Themes§

Hieroglyph themes are based on Sphinx’s HTML themes. Themes are either a directory or zipfile, which contains a theme.conf file, templates you wish to override, and a static/ directory which contains images, CSS, etc.

When defining a slide theme, inherit from the slides theme for basic support. For example, the single-level them has the following theme.conf:

inherit = slides
stylesheet = single.css

custom_css =

In order to include the base slide styling, your theme’s stylesheet should begin with:

@import url(slides.css);

slides.css will be supplied by the base theme (slides).

See the Sphinx documentation for themes for more information.

Per-File Configuration§

When working with multi-file projects, there may be cases when it is desirable to override the theme or set configuration value for specific files. This can be accomplished using the slideconf directive:

.. slideconf::
   :theme: single-level

Values specified in a slideconf directive override defaults specified in If more than one slideconf appears in a document, only the last one is used.

Project Versions

Table Of Contents

Previous topic

Styling Slides

Next topic

Hieroglyph Builders

This Page