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

Merge pull request #8766 from tk0miya/8232_graphviz_in_subdir

Browse Source 
graphviz: Image node is not rendered if graph file is in subdir (refs: #8232)
This commit is contained in:
Takeshi KOMIYA 2021-01-28 01:01:42 +09:00 committed by GitHub
commit 7f63c5442e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -76,6 +76,7 @@ Bugs fixed
* #8134: autodoc: crashes when mocked decorator takes arguments * #8134: autodoc: crashes when mocked decorator takes arguments
* #8306: autosummary: mocked modules are documented as empty page when using * #8306: autosummary: mocked modules are documented as empty page when using
:recursive: option :recursive: option
* #8232: graphviz: Image node is not rendered if graph file is in subdirectory
* #8618: html: kbd role produces incorrect HTML when compound-key separators (-, * #8618: html: kbd role produces incorrect HTML when compound-key separators (-,
+ or ^) are used as keystrokes + or ^) are used as keystrokes
* #8629: html: A type warning for html_use_opensearch is shown twice * #8629: html: A type warning for html_use_opensearch is shown twice

27
sphinx/ext/graphviz.py
View File

@ -142,6 +142,7 @@ class Graphviz(SphinxDirective):
'it failed') % filename, line=self.lineno)] 'it failed') % filename, line=self.lineno)]
else: else:
dotcode = '\n'.join(self.content) dotcode = '\n'.join(self.content)
rel_filename = None
if not dotcode.strip(): if not dotcode.strip():
return [self.state_machine.reporter.warning( return [self.state_machine.reporter.warning(
__('Ignoring "graphviz" directive without content.'), __('Ignoring "graphviz" directive without content.'),
@ -160,6 +161,8 @@ class Graphviz(SphinxDirective):
node['align'] = self.options['align'] node['align'] = self.options['align']
if 'class' in self.options: if 'class' in self.options:
node['classes'] = self.options['class'] node['classes'] = self.options['class']
if rel_filename:
node['filename'] = rel_filename
if 'caption' not in self.options: if 'caption' not in self.options:
self.add_name(node) self.add_name(node)
@ -213,8 +216,8 @@ class GraphvizSimple(SphinxDirective):
return [figure] return [figure]
def render_dot(self: SphinxTranslator, code: str, options: Dict, def render_dot(self: SphinxTranslator, code: str, options: Dict, format: str,
format: str, prefix: str = 'graphviz') -> Tuple[str, str]: prefix: str = 'graphviz', filename: str = None) -> Tuple[str, str]:
"""Render graphviz code into a PNG or PDF output file.""" """Render graphviz code into a PNG or PDF output file."""
graphviz_dot = options.get('graphviz_dot', self.builder.config.graphviz_dot) graphviz_dot = options.get('graphviz_dot', self.builder.config.graphviz_dot)
hashkey = (code + str(options) + str(graphviz_dot) + hashkey = (code + str(options) + str(graphviz_dot) +
@ -238,7 +241,10 @@ def render_dot(self: SphinxTranslator, code: str, options: Dict,
dot_args.extend(['-T' + format, '-o' + outfn]) dot_args.extend(['-T' + format, '-o' + outfn])
docname = options.get('docname', 'index') docname = options.get('docname', 'index')
cwd = path.dirname(path.join(self.builder.srcdir, docname)) if filename:
cwd = path.dirname(path.join(self.builder.srcdir, filename))
else:
cwd = path.dirname(path.join(self.builder.srcdir, docname))
if format == 'png': if format == 'png':
dot_args.extend(['-Tcmapx', '-o%s.map' % outfn]) dot_args.extend(['-Tcmapx', '-o%s.map' % outfn])
@ -263,14 +269,14 @@ def render_dot(self: SphinxTranslator, code: str, options: Dict,
def render_dot_html(self: HTMLTranslator, node: graphviz, code: str, options: Dict, def render_dot_html(self: HTMLTranslator, node: graphviz, code: str, options: Dict,
prefix: str = 'graphviz', imgcls: str = None, alt: str = None prefix: str = 'graphviz', imgcls: str = None, alt: str = None,
) -> Tuple[str, str]: filename: str = None) -> Tuple[str, str]:
format = self.builder.config.graphviz_output_format format = self.builder.config.graphviz_output_format
try: try:
if format not in ('png', 'svg'): if format not in ('png', 'svg'):
raise GraphvizError(__("graphviz_output_format must be one of 'png', " raise GraphvizError(__("graphviz_output_format must be one of 'png', "
"'svg', but is %r") % format) "'svg', but is %r") % format)
fname, outfn = render_dot(self, code, options, format, prefix) fname, outfn = render_dot(self, code, options, format, prefix, filename)
except GraphvizError as exc: except GraphvizError as exc:
logger.warning(__('dot code %r: %s'), code, exc) logger.warning(__('dot code %r: %s'), code, exc)
raise nodes.SkipNode from exc raise nodes.SkipNode from exc
@ -315,13 +321,14 @@ def render_dot_html(self: HTMLTranslator, node: graphviz, code: str, options: Di
def html_visit_graphviz(self: HTMLTranslator, node: graphviz) -> None: def html_visit_graphviz(self: HTMLTranslator, node: graphviz) -> None:
render_dot_html(self, node, node['code'], node['options']) render_dot_html(self, node, node['code'], node['options'], filename=node.get('filename'))
def render_dot_latex(self: LaTeXTranslator, node: graphviz, code: str, def render_dot_latex(self: LaTeXTranslator, node: graphviz, code: str,
options: Dict, prefix: str = 'graphviz') -> None: options: Dict, prefix: str = 'graphviz', filename: str = None
) -> None:
try: try:
fname, outfn = render_dot(self, code, options, 'pdf', prefix) fname, outfn = render_dot(self, code, options, 'pdf', prefix, filename)
except GraphvizError as exc: except GraphvizError as exc:
logger.warning(__('dot code %r: %s'), code, exc) logger.warning(__('dot code %r: %s'), code, exc)
raise nodes.SkipNode from exc raise nodes.SkipNode from exc
@ -352,7 +359,7 @@ def render_dot_latex(self: LaTeXTranslator, node: graphviz, code: str,
def latex_visit_graphviz(self: LaTeXTranslator, node: graphviz) -> None: def latex_visit_graphviz(self: LaTeXTranslator, node: graphviz) -> None:
render_dot_latex(self, node, node['code'], node['options']) render_dot_latex(self, node, node['code'], node['options'], filename=node.get('filename'))
def render_dot_texinfo(self: TexinfoTranslator, node: graphviz, code: str, def render_dot_texinfo(self: TexinfoTranslator, node: graphviz, code: str,