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.

Sign up for GitHub

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

Jump to bottom

Add sphinx jquery extension to fix read-the-docs search #1433

Closed
wants to merge 2 commits into from
Closed

Add sphinx jquery extension to fix read-the-docs search #1433

wants to merge 2 commits into from

Conversation

bmhan12
Copy link
Contributor

@bmhan12 bmhan12 commented Sep 30, 2024 •
edited
Loading

This PR:

@bmhan12 bmhan12 added the Documentation Issues related to documentation label Sep 30, 2024
BradWhitlock
BradWhitlock approved these changes Sep 30, 2024
View reviewed changes
Copy link
Member

@BradWhitlock BradWhitlock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

white238
white238 reviewed Sep 30, 2024
View reviewed changes
src/conf.py Outdated
@@ -57,7 +57,8 @@
'sphinxcontrib.jquery',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax'
'sphinx.ext.mathjax',
'sphinxcontrib.jquery'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already on line 57

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D'oh - I was too reliant on diff highlighting.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interesting... I'll play around with this a bit.

Copy link
Contributor Author

@bmhan12 bmhan12 Sep 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks to be only "develop" branch/version of the documentation does not have the search working.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last time this happened, @kennyweiss helped by inspecting the html errors via the browser. This line specifically is what fixed it.

Copy link
Contributor Author

@bmhan12 bmhan12 Sep 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scratch that, "develop" works when I switch browsers/use a private tab. Probably just need to clear cache.

@bmhan12 bmhan12 added the invalid This doesn't seem right label Sep 30, 2024
@bmhan12
Copy link
Contributor Author

bmhan12 commented Sep 30, 2024

As @white238 pointed out, we already have jquery added.
Closing this PR.
I think the issue was related to do with my web browser caching. Not observing the error in a private window or by switching browsers.

@bmhan12 bmhan12 closed this Sep 30, 2024
@bmhan12 bmhan12 deleted the bugfix/han12/rtd_search branch September 30, 2024 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@white238 white238 white238 left review comments

@BradWhitlock BradWhitlock BradWhitlock approved these changes

@rhornung67 rhornung67 rhornung67 approved these changes

@cyrush cyrush Awaiting requested review from cyrush

@kennyweiss kennyweiss Awaiting requested review from kennyweiss

@agcapps agcapps Awaiting requested review from agcapps

Assignees
No one assigned
Labels
Documentation Issues related to documentation invalid This doesn't seem right
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bmhan12 @white238 @BradWhitlock @rhornung67