index.rst

Hieroglyph

.. ifslides::

   .. figure:: /_static/hieroglyphs.jpg
      :class: fill

      CC BY-SA http://www.flickr.com/photos/tamburix/2900909093/

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

.. ifnotslides::

   Whether you're already writing documentation with Sphinx, or just
   want to create presentations from easy to manage plain text source
   files, Hieroglyph can help. Check out :ref:`getting-started` for a
   walk through using Hieroglyph.

   .. toctree::
      :maxdepth: 2

      getting-started
      styling
      advanced
      config
      directives
      builders
      developing
      ref-index
      releases

License

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

Included slide CSS and JavaScript originally based on HTML 5 Slides licensed under the Apache Public License.

Related Projects

• Sphinx
• Docutils
• rst2s5
• HTML 5 Slides