Merge pull request #4055 from oliver-sanders/fix-graphviz-svg-alignment

Fix ext.graphviz alignment.

sphinx/ext/graphviz.py

@@ -246,14 +246,14 @@ def render_dot_html(self, node, code, options, prefix='graphviz',
         if alt is None:
             alt = node.get('alt', self.encode(code).strip())
         imgcss = imgcls and 'class="%s"' % imgcls or ''
+        if 'align' in node:
+            self.body.append('<div align="%s" class="align-%s">' %
+                             (node['align'], node['align']))
         if format == 'svg':
             svgtag = '''<object data="%s" type="image/svg+xml">
             <p class="warning">%s</p></object>\n''' % (fname, alt)
             self.body.append(svgtag)
         else:
-            if 'align' in node:
-                self.body.append('<div align="%s" class="align-%s">' %
-                                 (node['align'], node['align']))
             with open(outfn + '.map', 'rb') as mapfile:
                 imgmap = mapfile.readlines()
             if len(imgmap) == 2:
@@ -266,8 +266,8 @@ def render_dot_html(self, node, code, options, prefix='graphviz',
                 self.body.append('<img src="%s" alt="%s" usemap="#%s" %s/>\n' %
                                  (fname, alt, mapname, imgcss))
                 self.body.extend([item.decode('utf-8') for item in imgmap])
-            if 'align' in node:
+        if 'align' in node:
-                self.body.append('</div>\n')
+            self.body.append('</div>\n')
 
     raise nodes.SkipNode
 
@@ -286,24 +286,26 @@ def render_dot_latex(self, node, code, options, prefix='graphviz'):
         raise nodes.SkipNode
 
     is_inline = self.is_inline(node)
-    if is_inline:
-        para_separator = ''
-    else:
-        para_separator = '\n'
 
-    if fname is not None:
+    if not is_inline:
-        post = None  # type: unicode
+        pre = ''
-        if not is_inline and 'align' in node:
+        post = ''
+        if 'align' in node:
             if node['align'] == 'left':
-                self.body.append('{')
+                pre = '{'
-                post = '\\hspace*{\\fill}}'
+                post = r'\hspace*{\fill}}'
             elif node['align'] == 'right':
-                self.body.append('{\\hspace*{\\fill}')
+                pre = r'{\hspace*{\fill}'
                 post = '}'
-        self.body.append('%s\\includegraphics{%s}%s' %
+            elif node['align'] == 'center':
-                         (para_separator, fname, para_separator))
+                pre = r'{\hfill'
-        if post:
+                post = r'\hspace*{\fill}}'
-            self.body.append(post)
+        self.body.append('\n%s' % pre)
+
+    self.body.append(r'\includegraphics{%s}' % fname)
+
+    if not is_inline:
+        self.body.append('%s\n' % post)
 
     raise nodes.SkipNode
 

tests/roots/test-ext-graphviz/index.rst

@@ -25,3 +25,8 @@ Hello |graph| graphviz world
    :caption: on right
 
    foo -> bar
+
+.. digraph:: foo
+   :align: center
+
+   centered

tests/test_ext_graphviz.py

@@ -16,7 +16,7 @@ import pytest
 
 @pytest.mark.sphinx('html', testroot='ext-graphviz')
 @pytest.mark.usefixtures('if_graphviz_found')
-def test_graphviz_html(app, status, warning):
+def test_graphviz_png_html(app, status, warning):
     app.builder.build_all()
 
     content = (app.outdir / 'index.html').text()
@@ -34,6 +34,51 @@ def test_graphviz_html(app, status, warning):
             r'<span class="caption-text">on right</span>.*</p>\s*</div>')
     assert re.search(html, content, re.S)
 
+    html = (r'<div align=\"center\" class=\"align-center\">'
+            r'<img src=\".*\.png\" alt=\"digraph foo {\n'
+            r'centered\n'
+            r'}\" />\n</div>')
+    assert re.search(html, content, re.S)
+
+@pytest.mark.sphinx('html', testroot='ext-graphviz',
+                    confoverrides={'graphviz_output_format': 'svg'})
+@pytest.mark.usefixtures('if_graphviz_found')
+def test_graphviz_svg_html(app, status, warning):
+    app.builder.build_all()
+
+    content = (app.outdir / 'index.html').text()
+
+    html = (r'<div class=\"figure\" .*?>\n'
+            r'<object data=\".*\.svg\".*>\n'
+            r'\s+<p class=\"warning\">digraph foo {\n'
+            r'bar -&gt; baz\n'
+            r'}</p></object>\n'
+            r'<p class=\"caption\"><span class=\"caption-text\">'
+            r'caption of graph</span>.*</p>\n</div>')
+    assert re.search(html, content, re.S)
+
+    html = (r'Hello <object.*>\n'
+            r'\s+<p class=\"warning\">graph</p></object>\n'
+            r' graphviz world')
+    assert re.search(html, content, re.S)
+
+    html = (r'<div class=\"figure align-right\" .*\>\n'
+            r'<object data=\".*\.svg\".*>\n'
+            r'\s+<p class=\"warning\">digraph bar {\n'
+            r'foo -&gt; bar\n'
+            r'}</p></object>\n'
+            r'<p class=\"caption\"><span class=\"caption-text\">'
+            r'on right</span>.*</p>\n'
+            r'</div>')
+    assert re.search(html, content, re.S)
+
+    html = (r'<div align=\"center\" class=\"align-center\">'
+            r'<object data=\".*\.svg\".*>\n'
+            r'\s+<p class=\"warning\">digraph foo {\n'
+            r'centered\n'
+            r'}</p></object>\n'
+            r'</div>')
+    assert re.search(html, content, re.S)
 
 @pytest.mark.sphinx('latex', testroot='ext-graphviz')
 @pytest.mark.usefixtures('if_graphviz_found')
@@ -54,6 +99,11 @@ def test_graphviz_latex(app, status, warning):
              '\\\\caption{on right}\\\\label{.*}\\\\end{wrapfigure}')
     assert re.search(macro, content, re.S)
 
+    macro = (r'\{\\hfill'
+             r'\\includegraphics{graphviz-.*}'
+             r'\\hspace\*{\\fill}}')
+    assert re.search(macro, content, re.S)
+
 
 @pytest.mark.sphinx('html', testroot='ext-graphviz', confoverrides={'language': 'xx'})
 @pytest.mark.usefixtures('if_graphviz_found')