Skip to content

Docs: update docs about search on subprojects #8683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2021
Merged

Docs: update docs about search on subprojects #8683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/subprojects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ https://docs.example.com/projects/bar/en/latest/
Search
------

Projects that are configured as subprojects will share a search index with their
parent and sibling projects. This is currently the only way to share search
indexes between projects, we do not yet support sharing search indexes between
arbitrary projects.
Search on the parent project will include results from its subprojects.
If you search on the ``v1`` version of the parent project,
results from the ``v1`` version of its subprojects will be included,
or from the default version for subprojects that don't have a ``v1`` version.

This is currently the only way to share search results between projects,
we do not yet support sharing search results between sibling subprojects or arbitrary projects.