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 slides 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/.
News
0.3.1
Release date: 5 June 2012
Added content, code missing from the 0.3 release.
Updated README to reflect changes in 0.3.
Changed docs configuration to build HTML + Slides.
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
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file hieroglyph-0.3.1.tar.gz.
File metadata
- Download URL: hieroglyph-0.3.1.tar.gz
- Upload date:
- Size: 179.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
199b7430f9b5e8dd9a52d7c4c31a18f2e04a9e01155dcc8f39e3f224cfff8214
|
|
| MD5 |
3ed46e88d3b51df27d33d26dbdba7198
|
|
| BLAKE2b-256 |
e9ff236f7f5172aad36c0f7e98063716db556c93ec512004baf1c5d7bc40d396
|
