Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Figure out section-based searching #23
It would be neat to be able to search a subset of the docs. An example:
if I did a search at https://docs.readthedocs.io/en/latest/development/install.html -- I had the option to only search inside
I think the best option here will be to enable authors to define sections that they want to be able to search within. We have HTMLFile's, so we could see what sections of files users have, and let them create a config that sets these sections as searchable. This could look like:
We could also in theory auto-generate this from the
@dojutsu-user has an initial demo of this that parses the URL directly from the current page. This is one possible option, but we likely want to let users have a bit more knowledge and UX around sections. Need to think about this more.