readthedocs / readthedocs-sphinx-search

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.
https://readthedocs-sphinx-search.readthedocs.io/
MIT License
33 stars 16 forks source link

sphinx-search and sphinx-intersphinx #138

Closed jaygray0919 closed 1 year ago

jaygray0919 commented 1 year ago

If I use intersphinx to link other sphinx instances e.g.

intersphinx_mapping = {
    'ewb': ('https://ewb.readthedocs.io/en/latest/', None),
    'rdf': ('https://rdfabout.readthedocs.io/en/latest/', None),
}

how to configure sphinx-search to search those instances for a specified string?

For example, looking here: https://readthedocs-sphinx-search.readthedocs.io/en/latest/customization.html#custom-styles

<a href="/api-v2?highlight=api">
              <h2 class="search__result__title">
                     API v2
                     <br />
              </h2>
 </a>

Search is relative to the page from which the search is launched.

Is it possible to specify other search domains - following the intersphinx method to :ref: another sphinx instance?

stsewd commented 1 year ago

Hi, you can use our search filter options, see https://readthedocs-sphinx-search.readthedocs.io/en/latest/configuration.html#confval-rtd_sphinx_search_default_filter, and https://docs.readthedocs.io/en/stable/server-side-search/syntax.html.

jaygray0919 commented 1 year ago

Thanks - will do this now /jay