diff options
| -rw-r--r-- | CHANGES | 1 | ||||
| -rw-r--r-- | doc/usage/extensions/graphviz.rst | 21 | ||||
| -rw-r--r-- | sphinx/ext/graphviz.py | 12 | ||||
| -rw-r--r-- | tests/roots/test-ext-graphviz/index.rst | 3 | ||||
| -rw-r--r-- | tests/test_ext_graphviz.py | 5 |
5 files changed, 35 insertions, 7 deletions
@@ -26,6 +26,7 @@ Features added * #6446: duration: Add ``sphinx.ext.durations`` to inspect which documents slow down the build * #6837: LaTeX: Support a nested table +* #6966: graphviz: Support ``:class:`` option Bugs fixed ---------- diff --git a/doc/usage/extensions/graphviz.rst b/doc/usage/extensions/graphviz.rst index dd21b8214..32cfcce30 100644 --- a/doc/usage/extensions/graphviz.rst +++ b/doc/usage/extensions/graphviz.rst @@ -82,6 +82,13 @@ It adds these directives: .. versionadded:: 1.6 + .. rst:directive:option:: class: class names + :type: a list of class names separeted by spaces + + The class name of the graph. + + .. versionadded:: 2.4 + .. rst:directive:: graph @@ -131,6 +138,13 @@ It adds these directives: .. versionadded:: 1.6 + .. rst:directive:option:: class: class names + :type: a list of class names separeted by spaces + + The class name of the graph. + + .. versionadded:: 2.4 + .. rst:directive:: digraph @@ -176,6 +190,13 @@ It adds these directives: .. versionadded:: 1.6 + .. rst:directive:option:: class: class names + :type: a list of class names separeted by spaces + + The class name of the graph. + + .. versionadded:: 2.4 + There are also these config values: diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index c16952bc0..6ff1193d0 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -121,6 +121,7 @@ class Graphviz(SphinxDirective): 'layout': directives.unchanged, 'graphviz_dot': directives.unchanged, # an old alias of `layout` option 'name': directives.unchanged, + 'class': directives.class_option, } def run(self) -> List[Node]: @@ -158,6 +159,8 @@ class Graphviz(SphinxDirective): node['alt'] = self.options['alt'] if 'align' in self.options: node['align'] = self.options['align'] + if 'class' in self.options: + node['classes'] = self.options['class'] if 'caption' not in self.options: self.add_name(node) @@ -182,6 +185,7 @@ class GraphvizSimple(SphinxDirective): 'caption': directives.unchanged, 'graphviz_dot': directives.unchanged, 'name': directives.unchanged, + 'class': directives.class_option, } def run(self) -> List[Node]: @@ -195,6 +199,8 @@ class GraphvizSimple(SphinxDirective): node['alt'] = self.options['alt'] if 'align' in self.options: node['align'] = self.options['align'] + if 'class' in self.options: + node['classes'] = self.options['class'] if 'caption' not in self.options: self.add_name(node) @@ -267,10 +273,8 @@ def render_dot_html(self: HTMLTranslator, node: graphviz, code: str, options: Di logger.warning(__('dot code %r: %s'), code, exc) raise nodes.SkipNode - if imgcls: - imgcls += " graphviz" - else: - imgcls = "graphviz" + classes = [imgcls, 'graphviz'] + node.get('classes', []) + imgcls = ' '.join(filter(None, classes)) if fname is None: self.body.append(self.encode(code)) diff --git a/tests/roots/test-ext-graphviz/index.rst b/tests/roots/test-ext-graphviz/index.rst index e67d1d082..e6db9b220 100644 --- a/tests/roots/test-ext-graphviz/index.rst +++ b/tests/roots/test-ext-graphviz/index.rst @@ -14,8 +14,9 @@ Hello |graph| graphviz world .. digraph:: foo :graphviz_dot: neato + :class: neato_graph - bar -> baz + baz -> qux .. graphviz:: graph.dot diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index ec905aa5f..f1ae8d17e 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -29,8 +29,9 @@ def test_graphviz_png_html(app, status, warning): html = 'Hello <div class="graphviz"><img .*?/></div>\n graphviz world' assert re.search(html, content, re.S) - html = '<img src=".*?" alt="digraph {\n bar -> baz\n}" class="graphviz" />' - assert re.search(html, content, re.M) + html = ('<img src=".*?" alt="digraph foo {\nbaz -> qux\n}" ' + 'class="graphviz neato-graph" />') + assert re.search(html, content, re.S) html = (r'<div class="figure align-right" .*?>\s*' r'<div class="graphviz"><img .*?/></div>\s*<p class="caption">' |