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

[BUG] Class method hyperlinks don't work in PL docs #6066

Open
1 task done
mudit2812 opened this issue Aug 5, 2024 · 2 comments
Open
1 task done

[BUG] Class method hyperlinks don't work in PL docs #6066

mudit2812 opened this issue Aug 5, 2024 · 2 comments
Labels
bug 🐛 Something isn't working

Comments

@mudit2812
Copy link
Contributor

mudit2812 commented Aug 5, 2024

Expected behavior

When I click on a class's method that has been hyperlinked, I expect to be taken to the docstring for that method.

Actual behavior

If the "Methods" dropdown at the bottom of a Class's page is minimized, clicking on the link does nothing. I do get taken to the correct method's docstring if I refresh the page though or if the "Methods" dropdown is expanded.

For example, in the below picture, all of the functions highlighted in red are hyperlinked, but nothing happens if I click on them. Example taken from QubitDevice docs.

image

Additional information

I have tried this on Safari and Brave (chromium based) browsers

Source code

No response

Tracebacks

No response

System information

PL dev

Existing GitHub issues

  • I have searched existing GitHub issues to make sure the issue does not already exist.
@mudit2812 mudit2812 added the bug 🐛 Something isn't working label Aug 5, 2024
@Ayobami-00
Copy link

Hi @mudit2812.

I'd like to work on this issue. Could you please assign it to me?

@mudit2812
Copy link
Contributor Author

Hey @Ayobami-00, thanks for your interest in contributing to PennyLane. We've found that this particular issue stems from how the Sphinx theme for our docs has been set up. It is not something that can be fixed by making changes to the pennylane repository, and so, it has been internally assigned to our Cloud team. If you're interested in contributing to PennyLane, you're welcome to take a look at our other open issues 😄.

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

No branches or pull requests

2 participants