Hieroglyph

Hieroglyph is an extension for Sphinx which builds HTML presentations from ReStructured Text documents.

Installing

You can install Hieroglyph using easy_install or pip:

$ 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.

Using Hieroglyph

You can start a new Hieroglyph presentation using the included quickstart script:

$ hieroglyph-quickstart

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:

$ 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.

Connect

You can connect with other Hieroglyph users and the developers via the hieroglyph-users email list (Google Groups). A Gmane archive is also available.

Developing

Making a Release

Hieroglyph uses Versioneer for 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 as hieroglyph-x.y.z

• Build the distributions using setup.py:

  $ python setup.py sdist bdist_wheel
  

• Push the changes to Github & upload to PyPI using Twine:

  $ git push origin head
  $ twine upload dist/<built filenames>
  

License

Hieroglyph is made available under a BSD license; see LICENSE for details.

Included slide CSS and JavaScript originally based on HTML 5 Slides and io-2012-slides projects licensed under the Apache Public License.