Setup algolia for documentation search

[noklam]

Signed-off-by: Nok nok.lam.chan@quantumblack.com

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

Fixed #2932

Setup according to: https://github.com/algolia/sphinx-docsearch

Development notes

• Let's drop some documentations

Checklist

• Read the contributing guidelines
• 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

[noklam]

UI is kind of working here but maybe it looks ugly. I am still figuring out how to make the index work.

https://5500-kedroorg-kedro-osrow6gr443.ws-eu104.gitpod.io/docs/build/html/index.html

[astrojuanlu]

There be dragons 🐉

[stichbury]

What are the dragons, @astrojuanlu if we make this upgrade?

[astrojuanlu]

Potentially some CSS breakage (sphinx, docutils, and sphinx-rtd-theme need to be upgraded at the same time).

Also, sphinx-autodoc-typehints had some problems in its newest version.

[astrojuanlu]

It's good that we upgrade our DocOps toolchain. Just that it might be its own ticket if things go awry.

[noklam]

The current index is empty, seems to be blocked by robots.txt.

[astrojuanlu]

The current index is empty, seems to be blocked by robots.txt.

What about https://docs.kedro.org/en/latest for instance?

[noklam]

It's not blocked but nothing is parsed either, looking into the configuration.

[noklam]

[stichbury]

Queries/issues that we're dealing with at present:

• We have to upgrade Sphinx (Need further info on what this could unleash)
• We need some CSS customisation (solvable)
• We seem to have to fix on one version to crawl (but we have multiple versions so is this the solution?)
• We aren't seeing breadcrumbs or text from the page (check out search on https://quarto.org/docs/get-started/ as an example)

This is what we're seeing so far:

[stichbury]

I've fiddled with this a bit but TBH I don't think I've had any impact whatsoever so have reverted my changes to the crawler.

I found this readthedocs/sphinx_rtd_theme#761 but it's quite old and may not be relevant.

I'm taking this off my queue now as I don't think it's a good use of my time, and we'll need to reevaluate how to proceed to get the search results optimised before handing to the website team to customise. Something to discuss with @noklam @merelcht and @astrojuanlu

[stichbury]

I've shared details with @SajidAlamQB and asked if he can take a look at these particular issues if time this sprint:

• We seem to have to fix on one version to crawl (but we have multiple versions so Example: adding Algolia Docsearch to a Sphinx setup that uses 'sphinx_rtd_theme' readthedocs/sphinx_rtd_theme#761 (comment)?)
• We aren't seeing breadcrumbs or text from the page (check out search on https://quarto.org/docs/get-started/ as an example)

[SajidAlamQB]

I tried to arrange a meeting with Algolia with help for this setup but unfortunately they aren't able to give technical advice directly. They directed us to rely on the docsearch solution.

[astrojuanlu]

I just applied to the DocSearch program 👍🏽

[stichbury]

I'm wondering if https://sphinxawesome.xyz/how-to/configure/#sec-docsearch may help us (using what the awesome-sphinx theme did to the same purpose on our theme). I'll take another look this week. https://sphinxawesome.xyz/how-to/configure/#sec-docsearch

[stichbury]

@noklam and @SajidAlamQB Thanks for your help with this. We have agreed in #2932 to suspend this for now but potentially return in future. So I'm closing the PR.