Searching is an important part of Read the Docs. This project aims to implement new features on the existing search backend, which are as follows:

  • In-Doc Search UI: Creating an Sphinx extension which provides a full-page search UI with "search as you type" capability.
  • Multiple Hits Per Search Result: Support results from sections of the docs.
  • Code Search: Index sphinx domain objects properly and improve the UI/UX around its search.
  • Search Analytics: Provide search analytics to the project admins.

Organization

Student

Vaibhav (dojutsu-user)

Mentors

  • David Fischer
  • Eric Holscher
close

2019