Fixes missing and broken links in inheritance diagrams by ayshih · Pull Request #10614 · sphinx-doc/sphinx

ayshih · 2022-06-29T14:29:04Z

Subject: Fixes missing and broken links in inheritance diagrams

Feature or Bugfix

Bugfix

Purpose

There are multiple bugs that result in missing or broken links in inheritance diagrams. The missing links are due to bugs that break the correct association of external classes with URLs. The broken links are specific to SVG output where the relative paths are not correctly re-pathed. This PR has been rewritten given #11078.

Detail

Missing links
- For intersphinx references where a class is found in an external inventory, reftitle does not contain the name of the class – instead, it is "(in <project> <version)" – so the actual name of the class must be separately constructed to build the class<->URL mapping (see inheritance_diagram should support linking via intersphinx #865)
Broken links
- Fixed a relative-path bug in ext.inheritance_diagram given the modifications to ext.graphviz in Fix relative references in SVGs generated by sphinx.ext.graphviz #11078

Relates

ayshih · 2022-06-29T14:30:54Z

This PR adds more fixes to my already open PR #10576. You can decide whether to review that one first or to simply review this one.

ayshih · 2022-09-27T12:44:04Z

I've gone ahead and closed #10576 so that there's just a single PR to review (i.e., this one).

Can I please get some feedback on this PR? Thanks!

AA-Turner · 2022-09-27T14:43:46Z

Can you change the base to 5.x?

A

ayshih · 2022-09-27T15:49:52Z

Okay, changed and rebased to 5.x

AA-Turner

Please avoid pathlib for now, and add tests for the changed behaviour. You also need to add an entry to CHANGES.

A

sphinx/ext/inheritance_diagram.py

ayshih · 2022-10-01T03:09:37Z

Apologies for the noise about the fuzzy matching! When crafting all of the tests, I discovered that the issue with fuzzy matching is actually an interaction with a third-party extension (sphinx-automodapi). I've accordingly ripped out that part of the PR, and the remaining fixes are all for bugs in first-party Sphinx.

ayshih · 2022-10-01T03:31:19Z

Tests all green, PR ready for re-review, thanks!

ayshih · 2022-11-02T14:40:42Z

@AA-Turner: I see that you changed the base branch to master, so I've rebased this PR and moved the CHANGES entry to be under 6.0.0 (but it'd be nice if these fixes were backported). Can you please re-review this PR? You may have missed that I added thorough unit tests, so I don't think there's anything else that I need to do. I see that another package has noted the existence of this PR and is also awaiting these long-standing bugs to be fixed.

ayshih · 2023-02-25T04:44:45Z

@AA-Turner: Sorry to be a bother, but can you please re-review this? All tests are green, including the ones that I added. Thanks!

AA-Turner · 2023-07-28T17:07:03Z

@ayshih one of the new tests is failing (test_inheritance_diagram_svg_html), please would you have a look?

A

ayshih · 2023-07-31T04:27:44Z

@AA-Turner: So, it turns out that the recently merged #11078 addresses some of the bugs that are fixed in this PR as well, but from a different angle. This PR is specific to inheritance diagrams and generates the correctly pathed URLs before passing them to the graphviz writer, while #11078 instead modifies the graphviz writer to accept URLs with the "wrong" relative path and rewrites them to have the correct path. Since the graphviz writer has broader uses beyond just inheritance diagrams, I'll update this PR in light of #11078.

I'll note that #11078 actually seems to be slightly buggy, so I'll fix its issues. Also, this PR is not moot because the bug with intersphinx linking still needs to be addressed.

ayshih · 2023-07-31T14:53:18Z

Okay, this PR has been updated in light of #11078, including fixing links that #11078 inadvertently broke. All tests are green! (I've also tested using a real package (SunPy), and it works as intended.)

sphinx/ext/inheritance_diagram.py

…situations

…ss names for clarity

AA-Turner · 2023-08-08T19:33:05Z

Thanks @ayshih!

A

ayshih · 2023-08-08T19:38:41Z

Thanks!

pllim · 2023-08-10T14:22:06Z

Hello! Which Sphinx version is this patch expected to be in? 7.1.3? 7.2.0? 8.0?

AA-Turner · 2023-08-10T18:37:18Z

7.2.

A

ayshih mentioned this pull request Jun 29, 2022

Test docs build with sphinx-automodapi fork that fixes the inheritance-diagram links sunpy/sunpy#6267

Closed

ayshih mentioned this pull request Sep 27, 2022

Fixed path bug with links in SVG inheritance diagrams #10576

Closed

ayshih changed the base branch from 5.0.x to 5.x September 27, 2022 15:42

ayshih force-pushed the fix_inheritance_diagrams branch from c5c6a0d to df1faf5 Compare September 27, 2022 15:49

AA-Turner requested changes Sep 27, 2022

View reviewed changes

sphinx/ext/inheritance_diagram.py Show resolved Hide resolved

sphinx/ext/inheritance_diagram.py Outdated Show resolved Hide resolved

sphinx/ext/inheritance_diagram.py Outdated Show resolved Hide resolved

AA-Turner reviewed Sep 29, 2022

View reviewed changes

sphinx/ext/inheritance_diagram.py Outdated Show resolved Hide resolved

ayshih force-pushed the fix_inheritance_diagrams branch 3 times, most recently from 062ca0b to 207cdec Compare October 1, 2022 03:08

ayshih force-pushed the fix_inheritance_diagrams branch from 2d77c5e to 8a737db Compare October 1, 2022 03:24

AA-Turner changed the base branch from 5.x to master October 16, 2022 15:28

hamogu mentioned this pull request Nov 1, 2022

sphinx docs: links to classes in the class inheritance diagram are wrong sherpa/sherpa#542

Open

ayshih force-pushed the fix_inheritance_diagrams branch from 8a737db to be2f6de Compare November 2, 2022 14:34

ayshih mentioned this pull request Nov 17, 2022

Test docs build with Sphinx fork that fixes the inheritance-diagram links astropy/astropy#13357

Closed

ayshih force-pushed the fix_inheritance_diagrams branch from be2f6de to 77ea085 Compare February 7, 2023 03:11

ayshih force-pushed the fix_inheritance_diagrams branch from 77ea085 to cd3967d Compare February 25, 2023 04:32

rhugonnet mentioned this pull request Mar 2, 2023

Write documentation and streamline general behaviour GlacioHack/geoutils#351

Merged

AA-Turner added this to the some future version milestone Apr 29, 2023

ayshih mentioned this pull request Jul 31, 2023

Test (again) docs build with sphinx-automodapi fork that fixes the inheritance-diagram links astropy/astropy#15104

Closed

ayshih force-pushed the fix_inheritance_diagrams branch from 0cb91dd to caf54eb Compare July 31, 2023 14:40

AA-Turner self-requested a review August 5, 2023 03:02

AA-Turner reviewed Aug 5, 2023

View reviewed changes

sphinx/ext/inheritance_diagram.py Outdated Show resolved Hide resolved

AA-Turner reviewed Aug 5, 2023

View reviewed changes

sphinx/ext/inheritance_diagram.py Show resolved Hide resolved

AA-Turner approved these changes Aug 5, 2023

View reviewed changes

ayshih and others added 10 commits August 8, 2023 09:10

Fixed path bug with links in SVG inheritance diagrams

3941838

Fixed intersphinx links in inheritance diagrams

81808b7

Addressed comments and added changelog entry

e0931db

Test for valid links in PNG and SVG inheritance diagrams in multiple …

39c352d

…situations

Removed the toctree because it causes a test failure

9c101fa

Update tests

587f6b5

Fixed links in inheritance diagrams given changes to graphviz writer

94e9adb

Improved the unit test to cover one more kind of link and renamed cla…

bb89ffb

…ss names for clarity

Fixed the v2 inventory for the unit test

7ec2884

Flip the logical branching

65ff8c0

ayshih force-pushed the fix_inheritance_diagrams branch from 01ed411 to 65ff8c0 Compare August 8, 2023 13:11

AA-Turner merged commit 3e30fa3 into sphinx-doc:master Aug 8, 2023

ayshih mentioned this pull request Aug 9, 2023

Fix broken inheritance-diagram links due to the smart resolver astropy/sphinx-automodapi#172

Merged

This was referenced Aug 10, 2023

Links in the inheritance diagrams don't work sunpy/sunpy#2097

Closed

Sphinx class inheritance diagrams not linking classes correctly astropy/astropy#4935

Closed

AA-Turner modified the milestones: some future version, 7.2.0 Aug 11, 2023

This was referenced Aug 21, 2023

Use SVG inheritance diagrams now that linking has been fixed matplotlib/matplotlib#26567

Merged

Fixed two more bugs with SVG inheritance-diagram links #11634

Merged

github-actions bot locked as resolved and limited conversation to collaborators Sep 11, 2023

AA-Turner added the extensions:graphviz The `sphinx.ext.graphviz` or `sphinx.ext.inheritance_diagram` extensions label Jan 29, 2025

Uh oh!

Conversation

ayshih commented Jun 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Feature or Bugfix

Purpose

Detail

Relates

Uh oh!

ayshih commented Jun 29, 2022

Uh oh!

ayshih commented Sep 27, 2022

Uh oh!

AA-Turner commented Sep 27, 2022

Uh oh!

ayshih commented Sep 27, 2022

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ayshih commented Oct 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ayshih commented Oct 1, 2022

Uh oh!

ayshih commented Nov 2, 2022

Uh oh!

ayshih commented Feb 25, 2023

Uh oh!

AA-Turner commented Jul 28, 2023

Uh oh!

ayshih commented Jul 31, 2023

Uh oh!

ayshih commented Jul 31, 2023

Uh oh!

Uh oh!

Uh oh!

AA-Turner commented Aug 8, 2023

Uh oh!

ayshih commented Aug 8, 2023

Uh oh!

pllim commented Aug 10, 2023

Uh oh!

AA-Turner commented Aug 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ayshih commented Jun 29, 2022 •

edited

Loading

ayshih commented Oct 1, 2022 •

edited

Loading