Initial implementation of singlefile-slides builder. (#96)

NEWS.txt

@@ -1,6 +1,13 @@
 News
 ====
 
+0.8
+---
+
+*Release date: UNRELEASED*
+
+* Add `singlefile-slides` builder
+
 0.7.1
 -----
 

src/hieroglyph/__init__.py

@@ -19,6 +19,7 @@ def setup(app):
     # Register Builders
     app.add_builder(builder.SlideBuilder)
     app.add_builder(builder.DirectorySlideBuilder)
+    app.add_builder(builder.SingleFileSlideBuilder)
     app.add_builder(builder.InlineSlideBuilder)
     app.add_builder(builder.DirectoryInlineSlideBuilder)
 

src/hieroglyph/builder.py

@@ -6,6 +6,7 @@
 from docutils import nodes
 from sphinx.theming import Theme
 from sphinx.builders.html import (
+    SingleFileHTMLBuilder,
     StandaloneHTMLBuilder,
     DirectoryHTMLBuilder,
 )
@@ -197,6 +198,19 @@ class SlideBuilder(AbstractSlideBuilder, StandaloneHTMLBuilder):
     name = 'slides'
 
 
+class SingleFileSlideBuilder(AbstractSlideBuilder, SingleFileHTMLBuilder):
+    """This is the single file Slide HTML builder.
+
+    Its output is a directory with a single HTML file, along with the
+    needed style sheets and JavaScript.
+
+    Its name is ``singlefile-slides``.
+
+    """
+
+    name = 'singlefile-slides'
+
+
 class AbstractInlineSlideBuilder(object):
 
     name = 'inlineslides'

src/hieroglyph/tests/test_builder.py

@@ -1,3 +1,4 @@
+import glob
 from unittest import TestCase
 
 from sphinx_testing import (
@@ -106,3 +107,18 @@ def test_docstitle_fallback_to_html_title(self, app, status, warning):
             builder.globalcontext['docstitle'],
             builder.config.html_title,
         )
+
+
+class SingleFileBuilderTests(TestCase):
+
+    @with_app(
+        buildername='singlefile-slides',
+    )
+    def test_builds_single_file(self, app, *args):
+
+        app.build()
+
+        self.assertEqual(
+            len(glob.glob(app.builddir/'singlefile-slides'/'*.html')),
+            1,
+        )

src/hieroglyph/writer.py

@@ -206,7 +206,7 @@ def visit_slide(self, node):
 
     def depart_slide(self, node):
 
-        if not getattr(node, 'closed', False):
+        if self.current_slide and not getattr(node, 'closed', False):
 
             # mark the slide closed
             node.closed = True