IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Close #5124: graphviz: :graphviz_dot: option is renamed to :layout:

Browse Source
This commit is contained in:
Takeshi KOMIYA
2019-06-02 20:51:18 +09:00
parent bcc0ffbd18
commit ce2f9c2b94
3 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@@ -13,6 +13,8 @@ Deprecated
Features added
--------------
* #5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:``
Bugs fixed
----------

20
doc/usage/extensions/graphviz.rst
View File

@@ -63,13 +63,17 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
The graphviz command (ex. ``dot``, ``neato`` and so on) for rendering the
graph. By default, :confval:`graphviz_dot` is used.
The layout of the graph (ex. ``dot``, ``neato`` and so on). A path to the
graphviz commands are also allowed. By default, :confval:`graphviz_dot`
is used.
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text
@@ -114,10 +118,13 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text
@@ -156,10 +163,13 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text

5
sphinx/ext/graphviz.py
View File

@@ -127,7 +127,8 @@ class Graphviz(SphinxDirective):
'alt': directives.unchanged,
'align': align_spec,
'caption': directives.unchanged,
'graphviz_dot': directives.unchanged,
'layout': directives.unchanged,
'graphviz_dot': directives.unchanged, # an old alias of `layout` option
'name': directives.unchanged,
}
@@ -161,6 +162,8 @@ class Graphviz(SphinxDirective):
if 'graphviz_dot' in self.options:
node['options']['graphviz_dot'] = self.options['graphviz_dot']
if 'layout' in self.options:
node['options']['graphviz_dot'] = self.options['layout']
if 'alt' in self.options:
node['alt'] = self.options['alt']
if 'align' in self.options: