Package: hieroglyph
Hieroglyphis an extension forSphinxwhich builds HTML
presentations from ReStructured Text documents.InstallingYou can installHieroglyphusingeasy_installorpip:$ pip install hieroglyphYou can also install the latest development version, which may
contain new features:$ pip install git+https://github.com/nyergler/hieroglyph#egg=hieroglyphHieroglyph supports Sphinx 2.4 and later, and Python 3.7 and later.Using HieroglyphYou can start a newHieroglyphpresentation using the included
quickstart script:$ hieroglyph-quickstartThis 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 runningmake:$ make slidesYou can also addHieroglyphas a Sphinx extension to your
existing configuration:extensions = [
    'hieroglyph',
]Read the documentationfor all the details about using,
configuring, and extending Hieroglyph.ConnectYou can connect with other Hieroglyph users and the developers via thehieroglyph-usersemail list (Google Groups). AGmane archiveis
also available.DevelopingMaking a ReleaseHieroglyph usesVersioneerfor managing verison numbers. Versioneer is
able to derive a reasonable version number using git tags as the source of
truth.To create a release, do the following:Update the change log (NEWS.txt)Tag the release commit ashieroglyph-x.y.zBuild the distributions usingsetup.py:$ python setup.py sdist bdist_wheelPush the changes to Github & upload to PyPI usingTwine:$ git push origin head
$ twine upload dist/<built filenames>LicenseHieroglyphis made available under a BSD license; see LICENSE for
details.Included slide CSS and JavaScript originally based onHTML 5 Slidesandio-2012-slidesprojects licensed under the Apache Public
License.News2.1Release date: 4 July 2020Improved support with other Sphinx extensions; fixes #148, #168;
merges #1552.0Release date: 27 June 2020Drop support for Python 2.xDrop support for Sphinx < 2.0Fix compatibility with Sphinx 2 and 3Enabled parallel reading of source files1.0Release date: 7 September 2017Addsinglefile-slidesbuilderFix compatibility with Sphinx >= 1.5Moving to semantic versioning; major version bump indicates backward
incompatible changes (dropping Sphinx 1.2, 1.3 support)0.7.1Release date: 28 March 2015Addtitle-imageslide classBug fix:slides2theme includes extra slides (#92)Bug fix: entry point invocation relies on new setuptools (#94)Bug fix: RST quotes raise exceptions (#93)0.7Release date: 16 March 2015Themes now use a template fragment for rendering individual slides.
(Issue #49)Bug fix: files inhtml_static_dirwill now override theme files.
(Issue #54)Addedslide_titleconfiguration setting. (Issue #56)Addedslides2theme, 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 script0.6.5Release date: 1 March 2014Revert “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 forslide_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)Addednextslidedirective for splitting sections.
(Issue #46)Section classes are now added to the generated slides (Issue #50).0.6Release date: 8 August 2013Thenotedirective 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.Addedappearandfade-inslide classes for alternate
transitions.Addedhieroglyph-quickstartscript.Added testing framework, initial tests for directivesFixed bug where content was not removed with autoslides was
disabledSlides 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.5Release date: 19 March 2013Rewrote, updated, and expanded documentation, including the addition
of the Getting Started guide.Addedinline-contentsoption to theslidedirective.Fixed bug with image path calculation for documents in nested trees.
This primarily impacted images generated by other extensions, such
asblockdiag.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 theslidedirective.Simplified processing ofslideconfnodes: 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 Chrome0.5Release date: 24 December 2012Added support forslidedirectiveAddedautoslidesconfig parameter to allow disabling automatic
generation of slides from document text.Added inline slide builder.Renamedslidesandnotslidesdirectives toifslidesandifnotslides, 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 tot(wasESC).Fixed problems with styling nested listsFixed incompatibility with latex-pdf builder0.4Release date: 27 September 2012Print-specific styling for printing slidesTemplate and javascript clean-up/reorganizationMore accurate display of scaled slides on Slide TableInitial implementation of Presenter ConsoleThemes and docs include font files locallyChanged interlink configuration keys to be more consistent.Support for file-specific theme configurationSupport for slide numbering0.3.2Release date: 5 June 2012Correctly generate relative links between HTML & Slides0.3.1Release date: 5 June 2012Added content, code missing from the 0.3 release.Updated README to reflect changes in 0.3.Changed docs configuration to build HTML + Slides.0.3Release date: 4 June 2012Provide directory and standalone based builders.Addedslidesandnotslidesdirectives.Fix up absolute image paths from things like blockdiagPreliminary support for linking between HTML to SlidesPreliminary slide table supportBackward Incompatible Changes:Builders have been renamed toslidesanddirslides. If yourMakefilerefers tohtml5slidesordirhtml5slides, you
will need to update it.0.2Release date: 10 March 2012Initial implementation of Sphinx builder.Two themes: slides and single-levelBasic documentation