[Doc] Add Algolia search to docs #46477
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: pdmurray <peynmurray@gmail.com>
peytondmurray
force-pushed
the
43208-improve-doc-search
branch
from
017deaf
to
21b9163
Compare
|
Reverting since this broke doc build https://buildkite.com/ray-project/postmerge/builds/6103; I'll fix this forward |
can-anyscale
added a commit
that referenced
this pull request
Sep 4, 2024
This reverts commit 80e832c.
can-anyscale
added a commit
that referenced
this pull request
Sep 4, 2024
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
This PR updates the documentation search engine to use Algolia, improving search results. To add support for Algolia, I've - Added the `sphinx-docsearch==0.0.7` requirement. - Bumped the current `sphinx` version to `7.3.7`. - Committed the public Algolia search API key, [in accordance with their documentation](https://www.algolia.com/doc/guides/security/api-keys/#search-only-api-key). Signed-off-by: pdmurray <peynmurray@gmail.com> Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Oct 15, 2024
Reverts ray-project#46477 Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR updates the documentation search engine to use Algolia, improving search results.
To add support for Algolia, I've
sphinx-docsearch==0.0.7requirement.sphinxversion to7.3.7.Related issue number
Closes #43208.
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.