Hieroglyph is an extension for
Sphinx_ which builds HTML
presentations from ReStructured Text documents.
You can install Hieroglyph using
$ pip install hieroglyph
You can also install the latest development version, which may contain new features::
$ pip install git+https://github.com/nyergler/hieroglyph#egg=hieroglyph
Hieroglyph supports Sphinx 2.4 and later, and Python 3.7 and later.
You can start a new Hieroglyph presentation using the included quickstart script::
This 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 running
$ make slides
You can also add Hieroglyph as a Sphinx extension to your existing configuration::
extensions = [ 'hieroglyph', ]
Read the documentation_ for all the details about using,
configuring, and extending Hieroglyph.
You can connect with other Hieroglyph users and the developers via the
hieroglyph-users email list (Google Groups). A
Gmane archive is
Gmane archive: http://dir.gmane.org/gmane.comp.python.hieroglyph.user
Versioneer_ for managing verison numbers. Versioneer is
able to derive a reasonable version number using git tags as the source of
To create a release, do the following:
Update the change log (
Tag the release commit as
Build the distributions using
$ python setup.py sdist bdist_wheel
Push the changes to Github & upload to PyPI using
$ git push origin head $ twine upload dist/
Hieroglyph is made available under a BSD license; see LICENSE for details.
HTML 5 Slides
io-2012-slides projects licensed under the Apache Public
HTML 5 Slides: http://code.google.com/p/html5slides/
Read the documentation: http://docs.hieroglyph.io/