Bug 917290

Summary: inheritance_diagram extension fails
Product: [Fedora] Fedora Reporter: Thomas Moschny <thomas.moschny>
Component: python-sphinxAssignee: Michel Lind <michel>
Status: CLOSED CURRENTRELEASE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 19CC: a.badger, michel
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-04-10 18:35:26 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 914566    
Attachments:
Description Flags
patch to fix the quoting issue none

Description Thomas Moschny 2013-03-02 18:06:23 UTC 
Created attachment 704498 [details]
patch to fix the quoting issue

Description of problem:
inheritance_diagram extension fails

Version-Release number of selected component (if applicable):
1.1.3-6.fc19

How reproducible:
always

Steps to Reproduce:
mkdir test; cd test
cat >conf.py <<EOF
extensions = ['sphinx.ext.inheritance_diagram']
source_suffix = '.rst'
master_doc = 'index'
EOF
cat >index.rst <<EOF
.. inheritance-diagram:: codecs
EOF
sphinx-build . _build
  
Actual results:
[...]
Exception occurred:
  File "/usr/lib/python2.7/site-packages/sphinx/ext/graphviz.py", line 219, in render_dot_html
    mapfile = open(outfn + '.map', 'rb')
IOError: [Errno 2] No such file or directory: '.../test/_build/_images/inheritance-90996c90890e28152202f5e31272c0b2afdca648.png.map'
[...]

Expected results:
Docs being generated without error.

Additional info:
This is caused by a quoting bug in sphinx/ext/inheritance_diagram.py, which creates wrong input for dot. Seems older dot versions somehow tolerated this.

The attached patch fixes the issue.

Note this has been fixed upstream in commit
https://bitbucket.org/birkenfeld/sphinx/commits/fc1db93d21a5a535d9d62e5a0c9f0a806a8c117a
This commit hasn't made it into a release yet, though.
Comment 1 Michel Lind 2013-03-09 03:17:11 UTC 
Thanks. I'll apply your patch, since the upstream patch also perform unrelated changes (that might not work properly if applied on top of the latest release)
Comment 2 Thomas Moschny 2013-03-09 10:49:17 UTC 
Thanks for applying the patch. Seems to work (even if a patch in waf was also needed to fix waf's FTBFS bug).
Comment 3 Fedora End Of Life 2013-04-03 19:33:39 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 19 development cycle.
Changing version to '19'.

(As we did not run this process for some time, it could affect also pre-Fedora 19 development
cycle bugs. We are very sorry. It will help us with cleanup during Fedora 19 End Of Life. Thank you.)

More information and reason for this action is here:
https://fedoraproject.org/wiki/BugZappers/HouseKeeping/Fedora19
Comment 4 Thomas Moschny 2013-04-10 18:35:26 UTC 
This is fixed.