Activate 'Read-the-Docs' Modal on Kedro Docs Search

[rashidakanchwala]

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Activate the 'read-the-docs' search modal when the user interacts with the search box on Kedro docs

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

• Read the contributing guidelines
• Signed off each commit with a Developer Certificate of Origin (DCO)
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added a description of this change in the RELEASE.md file
• Added tests to cover my changes
• Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

[astrojuanlu]

Seemingly we're still affected by this: readthedocs/addons#205

See https://rashida-test-kedro.readthedocs.io/en/latest/

[astrojuanlu]

Remaining: some CSS adjustments, see context in readthedocs/addons#175

[astrojuanlu]

The CSS tweaks are not urgent though, they don't affect the search experience and can be done in a separate PR

[humitos]

Seemingly we're still affected by this: readthedocs/addons#205

Thanks for reporting this issue to us. I've fixed it and deployed a newer version. I quickly tested in your project and I'm not able to reproduce it anymore. Let me know if it's working as you expected.

[astrojuanlu]

Thanks a lot @humitos! I tested it and it seems to work. Feel free to unsubscribe from this thread, we'll take it from here.

[astrojuanlu]

Thanks a lot @rashidakanchwala 🙏🏽

[astrojuanlu]

Reverting this to draft for now 👍🏽

[astrojuanlu]

I tested the two main changes:

• ✔️ The readthedocs-search-show event gets triggered on search box focus
• ✔️ The CSS looks exactly the same

We won't see the full effect until we enable the RTD add-ons in the project, which will happen to all versions. So, I say let's merge this PR already.

Thanks a lot @rashidakanchwala!

[merelcht]

Wow I didn't know this was coming, looks amazing 🤩