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

Broken Links in Inheritance Diagrams #459

Open
JonathanWenger opened this issue Jul 6, 2021 · 1 comment
Open

Broken Links in Inheritance Diagrams #459

JonathanWenger opened this issue Jul 6, 2021 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@JonathanWenger
Copy link
Contributor

Describe the bug
Inheritance diagrams in the documentation are clickable and should navigate to the corresponding section of the documentation. However, they omit one element of the path, namely the folder in which the automod directory is contained, e.g. they link to probnum/docs/_build/html/automod/probnum.linops.Identity.html instead of probnum/docs/_build/html/api/automod/probnum.linops.Identity.html. Note that this bug only appears when using SVG instead of png inheritance diagrams.

To Reproduce
Click on any class in an inheritance diagram:
Screenshot from 2021-07-06 18-59-01

Expected behavior
A link to the correct page of the documentation.

Cause of the bug
This is actually a bug in Sphinx itself when used in combination with automodapi. There are issues (sphinx-doc/sphinx#3176 ) and pull requests (sphinx-doc/sphinx#2484) mentioning this bug.

Possible fix
The suggested change in sphinx-doc/sphinx#2484 would fix this, if merged into Sphinx.
Possibly, we could monkey patch this ourselves by changing one line as in https://github.com/sphinx-doc/sphinx/pull/2484/files.

@JonathanWenger JonathanWenger added bug Something isn't working documentation Improvements or additions to documentation labels Jul 6, 2021
@JonathanWenger
Copy link
Contributor Author

This issue is actually a long-standing one in automodapi and also tracked in astropy/sphinx-automodapi#48.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant