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

Search inside documentation is broken #649

Closed
purva-thakre opened this issue Jul 3, 2024 · 4 comments · Fixed by #836
Closed

Search inside documentation is broken #649

purva-thakre opened this issue Jul 3, 2024 · 4 comments · Fixed by #836
Assignees
Labels
Milestone

Comments

@purva-thakre
Copy link
Collaborator

If I search for something in the search box of the docs, some suggestions show up. The link to these suggestions is broken.

image

https://toqito.readthedocs.io/en/latest/autoapi/matrices/gen_pauli_x/index.html

@purva-thakre purva-thakre added bug Something isn't working non-quantum labels Jul 3, 2024
@purva-thakre purva-thakre added this to the v1.0.9 milestone Jul 8, 2024
@purva-thakre
Copy link
Collaborator Author

This is because the links in the searchbox have a different URL than the correct links. undefinedautoapi/matrices/gen_pauli_x/index.html is appended to the working URL when it shows up in the searchbox.

@purva-thakre purva-thakre added the good first issue Good for newcomers label Jul 15, 2024
@vprusso
Copy link
Owner

vprusso commented Jul 15, 2024

If you copy the link in the search items that show up in the dropdown of the searchbox though, it looks like it has (what should be?) the correct link:
https://toqito.readthedocs.io/en/latest/#:~:text=matrices.-,gen_pauli_x,-Code%20reference

It does resolve to undefined, but that's still unclear to me at this time as to why.

@purva-thakre
Copy link
Collaborator Author

I think this is due to a bug in the documentation theme.

wagtail/sphinx-wagtail-theme#274

@vprusso
Copy link
Owner

vprusso commented Oct 6, 2024

I think this is due to a bug in the documentation theme.

wagtail/sphinx-wagtail-theme#274

Nice catch on this, @purva-thakre. I've opened up a PR here that switches to RTD and has a working search feature.
#836

@vprusso vprusso self-assigned this Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants