hie

hieroglyph

Generate HTML presentations from plain text sources with all the power of Sphinx.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

254

Maintenance

Last Commit

1yr ago

Contributors

31

Package

Dependencies

2

License

BSD

Categories

Readme

============

Hieroglyph

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

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.

.. hieroglyph-users: http://groups.google.com/d/forum/hieroglyph-users .. Gmane archive: http://dir.gmane.org/gmane.comp.python.hieroglyph.user

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/

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.

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100