hieroglyph
Advanced tools
.. image:: https://api.travis-ci.org/nyergler/hieroglyph.png?branch=master :target: https://travis-ci.org/nyergler/hieroglyph
.. image:: https://coveralls.io/repos/nyergler/hieroglyph/badge.png?branch=master :target: https://coveralls.io/r/nyergler/hieroglyph?branch=master
Hieroglyph is an extension for Sphinx_ which builds HTML
presentations from ReStructured Text documents.
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.
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.
You can connect with other Hieroglyph users and the developers via the
hieroglyph-users_ email list (Google Groups). A Gmane archive_ is
also available.
.. _hieroglyph-users: http://groups.google.com/d/forum/hieroglyph-users
.. _Gmane archive: http://dir.gmane.org/gmane.comp.python.hieroglyph.user
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/
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.
.. _Sphinx: http://sphinx.pocoo.org/
.. _HTML 5 Slides: http://code.google.com/p/html5slides/
.. _io-2012-slides: https://code.google.com/p/io-2012-slides/
.. _Read the documentation: http://docs.hieroglyph.io/
.. _Versioneer: https://github.com/warner/python-versioneer
.. _Twine: https://twine.readthedocs.io/en/latest/
.. _NEWS.txt: ./NEWS.txt
Release date: 4 July 2020
Release date: 27 June 2020
Release date: 7 September 2017
singlefile-slides builderRelease date: 28 March 2015
title-image slide classslides2 theme includes extra slides (#92)Release date: 16 March 2015
html_static_dir will now override theme files.
(Issue #54)slide_title configuration setting. (Issue #56)slides2 theme, based on updated Google HTML 5 slide
templates. (Issue #48)Release date: 1 March 2014
slide_footer (Issue #44)nextslide directive for splitting sections.
(Issue #46)Release date: 8 August 2013
note directive in a slide now shows up as notes in the
presenter console. Thanks, Doug Hellmann!appear and fade-in slide classes for alternate
transitions.hieroglyph-quickstart script.Release date: 19 March 2013
inline-contents option to the slide directive.blockdiag <https://pypi.python.org/pypi/sphinxcontrib-blockdiag>_.slide
directive.slideconf nodes: 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.Release date: 24 December 2012
slide directiveautoslides config parameter to allow disabling automatic
generation of slides from document text.slides and notslides directives to ifslides and
ifnotslides, respectively. The old names will continue to work
for a while, the rename just makes them more expressive.t (was ESC).Release date: 27 September 2012
Release date: 5 June 2012
Release date: 5 June 2012
Release date: 4 June 2012
slides and notslides directives.Backward Incompatible Changes:
* Builders have been renamed to ``slides`` and ``dirslides``. If your
``Makefile`` refers to ``html5slides`` or ``dirhtml5slides``, you
will need to update it.
0.2
---
*Release date: 10 March 2012*
* Initial implementation of Sphinx builder.
* Two themes: slides and single-level
* Basic documentation
FAQs
Generate HTML presentations from plain text sources with all the power of Sphinx.
We found that hieroglyph demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.
Security News
npm now links to Socket's security analysis on every package page. Here's what you'll find when you click through.