astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

Sphinx class inheritance diagrams not linking classes correctly #48

Closed hamogu closed 1 year ago

hamogu commented 6 years ago

E.g. at https://astropy.readthedocs.io/en/latest/visualization/index.html#module-astropy.visualization

click on any class in the graph-viz Diagram - None of them work, because there is a "/latest/" missing in the url. I'm reporting this here, but I'm not entirely sure if this is a sphinx-automodapi issue or related to some configuration in astropy itself.

nritsche commented 5 years ago

https://dias.readthedocs.io/en/rn-docs/dev/reference.html

The diagram links point to a different .rst than the class name links.

bsipocz commented 2 years ago

I've run into the broken links again, today.

It's useful to link to these following issues as PRs and most of the relevant discussions happened on them:

https://github.com/astropy/astropy/issues/4935

and upstream fixes and more discussions on how it should be fixed instead here, in this extension: https://github.com/sphinx-doc/sphinx/pull/2484 https://github.com/sphinx-doc/sphinx/pull/6454

ayshih commented 2 years ago

This is actually a bug in Sphinx after all. See sphinx-doc/sphinx#10576

pllim commented 2 years ago

Thanks for investigating and opening upstream fix!

pllim commented 1 year ago

I think this is fixed by #172