Sphinx: don't override html_context by default #10394
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
We have this feature enabled on .org and .com, we haven't heard any complaints. Closes #10293
benjaoming
approved these changes
Jun 6, 2023
There was a problem hiding this comment.
LGTM - but just curious, what happens to a Feature when its entry in the FEATURES list is removed? Should there be a data migration for all existing Feature records in the database to remove for instance everything that used to be related to DONT_OVERWRITE_SPHINX_CONTEXT?
|
@benjaoming we can just manually remove them from the DB after deploy (they are just 2, one for .org and one for .com), |
|
@stsewd sounds good 👍 a post-deploy task I guess? |
humitos
reviewed
Jun 7, 2023
| @@ -160,13 +160,9 @@ if version_info >= (1, 8): | |||
| {% block extra_context %}{% endblock %} | |||
|
|
|||
| if 'html_context' in globals(): | |||
| {% if dont_overwrite_sphinx_context %} | |||
There was a problem hiding this comment.
It would be good to write an explicit comment here noting that we are not overriding these on purpose
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.
We have this feature enabled on .org and .com,
we haven't heard any complaints.
Closes #10293
📚 Documentation previews 📚
docs): https://docs--10394.org.readthedocs.build/en/10394/dev): https://dev--10394.org.readthedocs.build/en/10394/