Metadata-Version: 1.0
Name: hieroglyph
Version: 0.3
Summary: UNKNOWN
Home-page: https://github.com/nyergler/hieroglyph
Author: Nathan Yergler
Author-email: nathan@yergler.net
License: BSD
Description: ============
         hieroglyph
        ============
        
        **hieroglyph** is an extension for Sphinx which builds HTML5 slides
        from ReStructured Text documents.
        
        Installing
        ==========
        
        You can install **hieroglyph** using ``easy_install`` or ``pip``::
        
           $ easy_install hieroglyph
        
        You can also download the `latest development version`_, which may
        contain new features.
        
        Using Hieroglyph
        ================
        
        Add **hieroglyph** as a Sphinx extension to your configuration::
        
          extensions = [
              'hieroglyph',
          ]
        
        Build your slides::
        
          $ sphinx-build -b html5slides sourcedir outdir
        
        Where sourcedir is the directory containing the sphinx conf.py file and 
        outdir is where you want your slides to output to.
        
        
        License
        =======
        
        **hieroglyph** is made available under a BSD license; see LICENSE for
        details.
        
        Included slide CSS and javascript licensed under the Apache Public
        License. See http://code.google.com/p/html5slides/.
        
        .. _`latest development version`: https://github.com/nyergler/hieroglyph/tarball/master#egg=hieroglyph-dev
        
        
        News
        ====
        
        0.3
        ---
        
        *Release date: 4 June 2012*
        
        * Provide directory and standalone based builders.
        * Added ``slides`` and ``notslides`` directives.
        * Fix up absolute image paths from things like blockdiag
        * Preliminary support for linking between HTML to Slides
        * Preliminary slide table support
        * Cleaned up and expanded documentation
        
        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
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing
