Read the Docs Search API

I stumbled across this API today: https://docs.datasette.io/_/api/v2/docsearch/?q=startup&project=datasette&version=stable&language=en

It's used by the search feature at https://docs.datasette.io/en/stable/search.html?q=startup&check_keywords=yes&area=default - I had assumed that feature was implemented in JavaScript (as is common in Sphinx world), but Read the Docs have upgraded it with their own backend search index.

It's built on Elasticsearch - they have developer docs for it here: https://github.com/readthedocs/readthedocs.org/blob/master/docs/development/search.rst

It looks like the key bits of the server-side implementation live here:

• https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/search/api.py
• https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/search/faceted_search.py

Related

• readthedocs Promoting the stable version of the documentation using rel=canonical - 2022-01-20
• sphinx Adding Sphinx autodoc to a project, and configuring Read The Docs to build it - 2021-08-10
• datasette Crawling Datasette with Datasette - 2022-02-27
• django PostgreSQL full-text search in the Django Admin - 2020-07-25
• google Limited JSON API for Google searches using Programmable Search Engine - 2023-09-16
• readthedocs Linking from /latest/ to /stable/ on Read The Docs - 2022-01-20
• django Building a blog in Django - 2023-08-15
• github Finding uses of an API with the new GitHub Code Search - 2022-12-08
• datasette Exploring Baseline with Datasette Lite - 2023-05-12
• sphinx Using sphinx.ext.extlinks for issue links - 2021-02-17

Created 2020-08-16T14:08:23-07:00 · Edit