Skip to content

Commit

Permalink
[Doc] Add Algolia search to docs (#46477)
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
peytondmurray authored Sep 2, 2024
1 parent 9a744a6 commit 80e832c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/requirements-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ setuptools>=70.0.0
Pygments==2.16.1

# Sphinx
sphinx==7.1.2
sphinx==7.3.7
sphinx-click==5.1.0
sphinx-copybutton==0.5.2
sphinxemoji==0.2.0
Expand All @@ -20,6 +20,7 @@ sphinx-autobuild==2024.4.16
pydata-sphinx-theme==0.14.1
autodoc_pydantic==2.2.0
appnope
sphinx-docsearch==0.0.7

pydantic!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,<3

Expand Down
6 changes: 6 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,14 @@
"sphinx_remove_toctrees",
"sphinx_design",
"sphinx.ext.intersphinx",
"sphinx_docsearch",
]

# Configuration for algolia
docsearch_app_id = "LBHF0PABBL"
docsearch_api_key = "6c42f30d9669d8e42f6fc92f44028596"
docsearch_index_name = "docs-ray"

remove_from_toctrees = [
"cluster/running-applications/job-submission/doc/*",
"ray-observability/reference/doc/*",
Expand Down

0 comments on commit 80e832c

Please sign in to comment.