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

docs - add sphinxcontrib.jquery extension to fix doc search #9655

Merged

Conversation

ajkerrigan
Copy link
Member

The Read the Docs theme for sphinx relies on jQuery in a few spots. It looks like we already have a sphinxcontrib-jquery dependency, but weren't referencing it as an extension in conf.py.

Adding this seems more "workaround" than fix - it may be worth following the related upstream issue or monkeypatching our way around jQuery in c7n-sphinxext.

See also: readthedocs/sphinx_rtd_theme#1546

Closes #9651

The Read the Docs theme for sphinx relies on jQuery in a few spots. It
looks like we already have a sphinxcontrib-jquery dependency, but weren't
referencing it as an extension in conf.py.

Adding this seems more "workaround" than fix - it may be worth following
the related upstream issue or monkeypatching our way around jQuery in
c7n-sphinxext.

See also: readthedocs/sphinx_rtd_theme#1546
Copy link
Collaborator

@kapilt kapilt left a comment

Choose a reason for hiding this comment

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

Lgtm, worth a shot

@ajkerrigan
Copy link
Member Author

Incidentally in local testing this also seems to fix broken expand/collapse behavior.

@ajkerrigan ajkerrigan merged commit 3f6375f into cloud-custodian:main Aug 2, 2024
22 checks passed
@ajkerrigan ajkerrigan deleted the fix/docs/add-jquery-extension branch August 2, 2024 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cloudcustodian.io search is broken
2 participants