Configuration Options¶
Hieroglyph supports several configuration settings, which can be set
in the project’s Sphinx configuration file. If you used
sphinx-quickstart
to begin your project, this will be conf.py
in the project directory.
Basic Configuration¶
-
slide_title
¶ Default: inherit from
html_title
Sets the title of slide project generated. This title will be used in the HTML title of the output.
-
autoslides
¶ Default:
True
When
autoslides
is True, Hieroglyph will generate slides from the document sections. If autoslides is set to False, only generate slides from theslide
directive.This can be overridden on a per-document basis using the
slideconf
directive.
-
slide_theme
¶ Default:
slides
The theme to use when generating slides. Hieroglyph includes two themes,
slides
andsingle-level
.This can be overridden on a per-document basis using the
slideconf
directive.See Styling Slides for more information.
Slide Numbers¶
-
slide_numbers
¶ Default:
False
If set to
True
, slide numbers will be added to the HTML output.
Themes¶
-
slide_theme_options
¶ Default:
{}
Theme specific options as a
dict
.See Custom CSS for more information.
-
slide_theme_path
¶ Default:
[]
.A list of paths to look for themes in.
For more information on styling and themes, see Styling Slides.
Interlinking HTML Output¶
Interlinking HTML Output can be enabled for slides, HTML, or both.
-
slide_link_to_html
¶ Default:
False
Link from slides to HTML.
-
slide_link_html_to_slides
¶ Default:
False
Link from HTML to slides.
-
slide_link_html_sections_to_slides
¶ Default:
False
Link individual HTML sections to specific slides.
Note that
slide_link_html_to_slides
must be enabled for this to have any effect.
Relative Paths¶
The slide/HTML interlinking needs to know how to find the slide and HTML output from the other side. There are two configuration parameters for this. They’re configured to work with Sphinx and Hieroglyph’s standard configuration (output in sub-directories of a common build directory) by default .
-
slide_relative_path
¶ Relative path from HTML to slides; default:
../slides/
-
slide_html_relative_path
¶ Relative path from slides to HTML; default:
../html/