Merge pull request #15 from kallimachos/repeat-option

Add image repeat option

doc/index.rst

@@ -83,6 +83,13 @@ sphinxmark_div (string)
 
      openstackdocstheme -> ``sphinxmark_div = 'docs-body'``
 
+sphinxmark_repeat (bool)
+   - ``True`` - image repeats down the page
+   - ``False`` - image appears once at top of page
+   - Default = True
+
+      ``sphinxmark_repeat = True``
+
 sphinxmark_image (string)
    - image file in ``html_static_path`` directory to use as watermark
    - ``text`` selects the text-based watermark specified in the
@@ -131,6 +138,7 @@ sphinxmark_text_spacing (int)
 
       ``sphinxmark_text_spacing = 400``
 
+
 Troubleshooting
 ~~~~~~~~~~~~~~~
 You can enable debugging output for sphinxmark by raising the output verbosity

sphinxmark/__init__.py

@@ -100,7 +100,12 @@ def watermark(app, env):
         else:
             div = app.config.sphinxmark_div
 
-        css = template('watermark', div=div, image=imagefile)
+        if app.config.sphinxmark_repeat is True:
+            repeat = 'repeat-y'
+        else:
+            repeat = 'no-repeat'
+
+        css = template('watermark', div=div, image=imagefile, repeat=repeat)
         app.debug('[sphinxmark] Template: ' + css)
         cssname = 'sphinxmark.css'
         cssfile = os.path.join(buildpath, cssname)
@@ -116,6 +121,7 @@ def setup(app):
     try:
         app.add_config_value('sphinxmark_enable', False, 'html')
         app.add_config_value('sphinxmark_div', 'default', 'html')
+        app.add_config_value('sphinxmark_repeat', True, 'html')
         app.add_config_value('sphinxmark_image', 'default', 'html')
         app.add_config_value('sphinxmark_text', 'default', 'html')
         app.add_config_value('sphinxmark_text_color', (255, 0, 0), 'html')

sphinxmark/watermark.tpl

@@ -1,5 +1,5 @@
 div.{{div}} {
   background-image: url("{{ image }}") !important;
-  background-repeat: repeat-y !important;
+  background-repeat: {{ repeat }} !important;
   background-position: center top !important;
   }

tests/marktest/conf.py

@@ -63,6 +63,7 @@
 # Options for sphinxmark
 sphinxmark_enable = True
 # sphinxmark_div = 'default'
+# sphinxmark_repeat = True
 # sphinxmark_image = 'default'
 # sphinxmark_text = 'default'
 # sphinxmark_text_color = (255, 0, 0)

tests/test.py

@@ -9,6 +9,7 @@
 
 # defaults = {'sphinxmark_enable': True,
 #             'sphinxmark_div': 'default',
+#             'sphinxmark_repeat': True,
 #             'sphinxmark_image': 'default',
 #             'sphinxmark_text': 'default',
 #             'sphinxmark_text_color': (255, 0, 0),
@@ -27,6 +28,7 @@ def test_defaults():
     app = MakeApp(srcdir='tests/marktest', copy_srcdir_to_tmpdir=True)
     app.builder.build_all()
     assert app.config.sphinxmark_div == 'default'
+    assert app.config.sphinxmark_repeat is True
     assert app.config.sphinxmark_image == 'default'
     assert app.config.sphinxmark_text == 'default'
     assert app.config.sphinxmark_text_color == (255, 0, 0)
@@ -41,6 +43,33 @@ def test_defaults():
     assert ('url("watermark-draft.png")') in css
 
 
+def test_repeat():
+    """Text repeat."""
+    app = MakeApp(srcdir='tests/marktest', copy_srcdir_to_tmpdir=True)
+    app.builder.build_all()
+    assert app.config.sphinxmark_repeat is True
+
+    html = (app.outdir / htmlfile).read_text()
+    assert htmlresult in html
+
+    css = (app.outdir / cssfile).read_text()
+    assert ('background-repeat: repeat-y !important;') in css
+
+
+def test_no_repeat():
+    """Text no repeat."""
+    app = MakeApp(srcdir='tests/marktest', copy_srcdir_to_tmpdir=True,
+                  confoverrides={'sphinxmark_repeat': False})
+    app.builder.build_all()
+    assert app.config.sphinxmark_repeat is False
+
+    html = (app.outdir / htmlfile).read_text()
+    assert htmlresult in html
+
+    css = (app.outdir / cssfile).read_text()
+    assert ('background-repeat: no-repeat !important;') in css
+
+
 def test_textmark():
     """Test textmark."""
     app = MakeApp(srcdir='tests/marktest', copy_srcdir_to_tmpdir=True,