docs: pass current_version to html_context #37008
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Andrii Iuspin <andrii.iuspin@isovalent.com>
qmonnet
approved these changes
Jan 16, 2025
|
/test |
45 tasks
19 tasks
6 tasks
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This explicitly sets the current_version in conf.py.
The current_version is used in the Algolia search filter to search only within the displayed documentation version, rather than across all versions.
Here is the link to the specific line in the layout.html file of the sphinx_rtd_theme: repository: https://github.com/cilium/sphinx_rtd_theme/blob/cilium/rebase-2023-09/sphinx_rtd_theme/layout.html#L361
However, it seems that the readthedocs build no longer passes the current_version into the sphinx html_context. This is likely due to changes in the builder, as described here: https://github.com/readthedocs/sphinx-build-compatibility
As a result, the search functionality is currently broken.