Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links in the inheritance diagrams don't work #2097

Closed
Cadair opened this issue May 7, 2017 · 11 comments
Closed

Links in the inheritance diagrams don't work #2097

Cadair opened this issue May 7, 2017 · 11 comments
Labels
Documentation Affects the documentation Effort Medium Requires a moderate time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required Upstream Fix Required A fix needs to go upstream to another package

Comments

@Cadair
Copy link
Member

Cadair commented May 7, 2017

see: http://docs.sunpy.org/en/latest/code_ref/timeseries.html#class-inheritance-diagram

@Cadair Cadair added the Documentation Affects the documentation label May 7, 2017
@Cadair
Copy link
Member Author

Cadair commented May 7, 2017

ping @Alex-Ian-Hamilton

@mirca
Copy link

mirca commented May 8, 2017

@Cadair FYI: astropy/photutils#345

@wtbarnes
Copy link
Member

wtbarnes commented May 8, 2017

And the original astropy issue: astropy/astropy#4935 though the consensus seems to be this is an upstream issue with Sphinx.

Either way, not unique to SunPy.

@swapsha96
Copy link
Contributor

If this issue is with Sphinx, we can implement the same using HTML Tag. The link gives an ugly example but same can be implemented with simple HTML.

@bsipocz
Copy link
Member

bsipocz commented May 16, 2017

This is somewhat related to our automodapi, as apparently it still works with pure sphinx:
sphinx-doc/sphinx#2484

@nabobalis nabobalis self-assigned this Jan 22, 2019
@nabobalis nabobalis removed their assignment Apr 5, 2019
@ayshih
Copy link
Member

ayshih commented Nov 27, 2019

For completeness in cross-referencing: astropy/sphinx-automodapi#48

@nabobalis nabobalis added Effort Medium Requires a moderate time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required Upstream Fix Required A fix needs to go upstream to another package labels Jul 11, 2020
@ayshih
Copy link
Member

ayshih commented Jun 17, 2022

My PR to finally fix this issue: astropy/sphinx-automodapi#152

@ayshih
Copy link
Member

ayshih commented Jun 19, 2022

While sphinx-doc/sphinx#10576 will fix in bug in Sphinx, I doubt the bugfix will be backported to releases prior to 5.0. Something in our dependency tree for the docs build is keeping Sphinx back at 4.5.

@nabobalis
Copy link
Contributor

While sphinx-doc/sphinx#10576 will fix in bug in Sphinx, I doubt the bugfix will be backported to releases prior to 5.0. Something in our dependency tree for the docs build is keeping Sphinx back at 4.5.

I am sure we can work out what is causing that and deal with it.

@ayshih
Copy link
Member

ayshih commented Aug 10, 2023

The bug fixes have been merged upstream (sphinx-doc/sphinx#10614 and astropy/sphinx-automodapi#172), so will presumably show up in respective new releases, but the inheritance diagrams will continue to be broken in our documentation until our theme no longer pins us to an old version of Sphinx (see sunpy/sunpy-sphinx-theme#188).

@ayshih
Copy link
Member

ayshih commented Sep 8, 2023

@Cadair has updated the theme, so this issue can finally be closed

@ayshih ayshih closed this as completed Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Affects the documentation Effort Medium Requires a moderate time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required Upstream Fix Required A fix needs to go upstream to another package
Projects
None yet
Development

No branches or pull requests

7 participants