Show the additional search views documentation on the API docs site #4056
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Fixes #4055 by @obulat
Description
This PR switches on the display of additional search views documentation on the API documentation site by setting the
SHOW_COLLECTION_DOCS
env variable and the default setting to true.Testing Instructions
Run the app without setting
SHOW_COLLECTION_DOCS
in theapi/.env
file, or setting it to True in theapi/.env
file, as in theapi/env.template
.When you run
just up
and visit the API locally, you should see the updated documentation for thesource
andcreator
parameters, and the additional search views parameters.Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin